diff --git a/.changes/3.315.2 b/.changes/3.315.2 new file mode 100644 index 0000000000..744f2115cc --- /dev/null +++ b/.changes/3.315.2 @@ -0,0 +1,47 @@ +[ + { + "type": "api-change", + "category": "Glue", + "description": "Added AttributesToGet parameter to Glue GetDatabases, allowing caller to limit output to include only the database name." + }, + { + "type": "api-change", + "category": "CloudHSMV2", + "description": "Added 3 new APIs to support backup sharing: GetResourcePolicy, PutResourcePolicy, and DeleteResourcePolicy. Added BackupArn to the output of the DescribeBackups API. Added support for BackupArn in the CreateCluster API." + }, + { + "type": "enhancement", + "category": "PI", + "description": "Noting that the filter db.sql.db_id isn't available for RDS for SQL Server DB instances." + }, + { + "type": "api-change", + "category": "WorkSpaces", + "description": "Added support for Red Hat Enterprise Linux 8 on Amazon WorkSpaces Personal." + }, + { + "type": "api-change", + "category": "OpenSearchService", + "description": "This release removes support for enabling or disabling Natural Language Query Processing feature for Amazon OpenSearch Service domains." + }, + { + "type": "api-change", + "category": "ACMPCA", + "description": "Added CCPC_LEVEL_1_OR_HIGHER KeyStorageSecurityStandard and SM2 KeyAlgorithm and SM3WITHSM2 SigningAlgorithm for China regions." + }, + { + "type": "api-change", + "category": "EMR", + "description": "This release provides the support for new allocation strategies i.e. CAPACITY_OPTIMIZED_PRIORITIZED for Spot and PRIORITIZED for On-Demand by taking input of priority value for each instance type for instance fleet clusters." + }, + { + "type": "api-change", + "category": "KinesisAnalyticsV2", + "description": "Support for Flink 1.19 in Managed Service for Apache Flink" + }, + { + "type": "api-change", + "category": "Connect", + "description": "This release supports showing PreferredAgentRouting step via DescribeContact API." + } +] diff --git a/CHANGELOG.md b/CHANGELOG.md index 476c5b3b4b..d16c392686 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # CHANGELOG +## next release + +* `Aws\Glue` - Added AttributesToGet parameter to Glue GetDatabases, allowing caller to limit output to include only the database name. +* `Aws\CloudHSMV2` - Added 3 new APIs to support backup sharing: GetResourcePolicy, PutResourcePolicy, and DeleteResourcePolicy. Added BackupArn to the output of the DescribeBackups API. Added support for BackupArn in the CreateCluster API. +* `Aws\PI` - Noting that the filter db.sql.db_id isn't available for RDS for SQL Server DB instances. +* `Aws\WorkSpaces` - Added support for Red Hat Enterprise Linux 8 on Amazon WorkSpaces Personal. +* `Aws\OpenSearchService` - This release removes support for enabling or disabling Natural Language Query Processing feature for Amazon OpenSearch Service domains. +* `Aws\ACMPCA` - Added CCPC_LEVEL_1_OR_HIGHER KeyStorageSecurityStandard and SM2 KeyAlgorithm and SM3WITHSM2 SigningAlgorithm for China regions. +* `Aws\EMR` - This release provides the support for new allocation strategies i.e. CAPACITY_OPTIMIZED_PRIORITIZED for Spot and PRIORITIZED for On-Demand by taking input of priority value for each instance type for instance fleet clusters. +* `Aws\KinesisAnalyticsV2` - Support for Flink 1.19 in Managed Service for Apache Flink +* `Aws\Connect` - This release supports showing PreferredAgentRouting step via DescribeContact API. + ## 3.315.1 - 2024-06-27 * `Aws\ElastiCache` - Add v2 smoke tests and smithy smokeTests trait for SDK testing. diff --git a/src/CloudHSMV2/CloudHSMV2Client.php b/src/CloudHSMV2/CloudHSMV2Client.php index a3628cb9ca..e35df36f69 100644 --- a/src/CloudHSMV2/CloudHSMV2Client.php +++ b/src/CloudHSMV2/CloudHSMV2Client.php @@ -17,10 +17,14 @@ * @method \GuzzleHttp\Promise\Promise deleteClusterAsync(array $args = []) * @method \Aws\Result deleteHsm(array $args = []) * @method \GuzzleHttp\Promise\Promise deleteHsmAsync(array $args = []) + * @method \Aws\Result deleteResourcePolicy(array $args = []) + * @method \GuzzleHttp\Promise\Promise deleteResourcePolicyAsync(array $args = []) * @method \Aws\Result describeBackups(array $args = []) * @method \GuzzleHttp\Promise\Promise describeBackupsAsync(array $args = []) * @method \Aws\Result describeClusters(array $args = []) * @method \GuzzleHttp\Promise\Promise describeClustersAsync(array $args = []) + * @method \Aws\Result getResourcePolicy(array $args = []) + * @method \GuzzleHttp\Promise\Promise getResourcePolicyAsync(array $args = []) * @method \Aws\Result initializeCluster(array $args = []) * @method \GuzzleHttp\Promise\Promise initializeClusterAsync(array $args = []) * @method \Aws\Result listTags(array $args = []) @@ -29,6 +33,8 @@ * @method \GuzzleHttp\Promise\Promise modifyBackupAttributesAsync(array $args = []) * @method \Aws\Result modifyCluster(array $args = []) * @method \GuzzleHttp\Promise\Promise modifyClusterAsync(array $args = []) + * @method \Aws\Result putResourcePolicy(array $args = []) + * @method \GuzzleHttp\Promise\Promise putResourcePolicyAsync(array $args = []) * @method \Aws\Result restoreBackup(array $args = []) * @method \GuzzleHttp\Promise\Promise restoreBackupAsync(array $args = []) * @method \Aws\Result tagResource(array $args = []) diff --git a/src/data/acm-pca/2017-08-22/api-2.json b/src/data/acm-pca/2017-08-22/api-2.json index 5e4bae6de3..e5c2bc7393 100644 --- a/src/data/acm-pca/2017-08-22/api-2.json +++ b/src/data/acm-pca/2017-08-22/api-2.json @@ -1038,14 +1038,16 @@ "RSA_2048", "RSA_4096", "EC_prime256v1", - "EC_secp384r1" + "EC_secp384r1", + "SM2" ] }, "KeyStorageSecurityStandard":{ "type":"string", "enum":[ "FIPS_140_2_LEVEL_2_OR_HIGHER", - "FIPS_140_2_LEVEL_3_OR_HIGHER" + "FIPS_140_2_LEVEL_3_OR_HIGHER", + "CCPC_LEVEL_1_OR_HIGHER" ] }, "KeyUsage":{ @@ -1359,7 +1361,8 @@ "SHA512WITHECDSA", "SHA256WITHRSA", "SHA384WITHRSA", - "SHA512WITHRSA" + "SHA512WITHRSA", + "SM3WITHSM2" ] }, "String":{"type":"string"}, diff --git a/src/data/acm-pca/2017-08-22/api-2.json.php b/src/data/acm-pca/2017-08-22/api-2.json.php index 46457ee8cb..23e8ff5fa0 100644 --- a/src/data/acm-pca/2017-08-22/api-2.json.php +++ b/src/data/acm-pca/2017-08-22/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2017-08-22', 'endpointPrefix' => 'acm-pca', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'ACM-PCA', 'serviceFullName' => 'AWS Certificate Manager Private Certificate Authority', 'serviceId' => 'ACM PCA', 'signatureVersion' => 'v4', 'targetPrefix' => 'ACMPrivateCA', 'uid' => 'acm-pca-2017-08-22', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'CreateCertificateAuthority' => [ 'name' => 'CreateCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCertificateAuthorityRequest', ], 'output' => [ 'shape' => 'CreateCertificateAuthorityResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgsException', ], [ 'shape' => 'InvalidPolicyException', ], [ 'shape' => 'InvalidTagException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'CreateCertificateAuthorityAuditReport' => [ 'name' => 'CreateCertificateAuthorityAuditReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCertificateAuthorityAuditReportRequest', ], 'output' => [ 'shape' => 'CreateCertificateAuthorityAuditReportResponse', ], 'errors' => [ [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidArgsException', ], [ 'shape' => 'InvalidStateException', ], ], 'idempotent' => true, ], 'CreatePermission' => [ 'name' => 'CreatePermission', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePermissionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'PermissionAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'RequestFailedException', ], ], ], 'DeleteCertificateAuthority' => [ 'name' => 'DeleteCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'DeletePermission' => [ 'name' => 'DeletePermission', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePermissionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'RequestFailedException', ], ], ], 'DeletePolicy' => [ 'name' => 'DeletePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePolicyRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'LockoutPreventedException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeCertificateAuthority' => [ 'name' => 'DescribeCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificateAuthorityRequest', ], 'output' => [ 'shape' => 'DescribeCertificateAuthorityResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], ], ], 'DescribeCertificateAuthorityAuditReport' => [ 'name' => 'DescribeCertificateAuthorityAuditReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificateAuthorityAuditReportRequest', ], 'output' => [ 'shape' => 'DescribeCertificateAuthorityAuditReportResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidArgsException', ], ], ], 'GetCertificate' => [ 'name' => 'GetCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCertificateRequest', ], 'output' => [ 'shape' => 'GetCertificateResponse', ], 'errors' => [ [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'GetCertificateAuthorityCertificate' => [ 'name' => 'GetCertificateAuthorityCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCertificateAuthorityCertificateRequest', ], 'output' => [ 'shape' => 'GetCertificateAuthorityCertificateResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidArnException', ], ], ], 'GetCertificateAuthorityCsr' => [ 'name' => 'GetCertificateAuthorityCsr', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCertificateAuthorityCsrRequest', ], 'output' => [ 'shape' => 'GetCertificateAuthorityCsrResponse', ], 'errors' => [ [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'GetPolicy' => [ 'name' => 'GetPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetPolicyRequest', ], 'output' => [ 'shape' => 'GetPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ImportCertificateAuthorityCertificate' => [ 'name' => 'ImportCertificateAuthorityCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportCertificateAuthorityCertificateRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'MalformedCertificateException', ], [ 'shape' => 'CertificateMismatchException', ], ], ], 'IssueCertificate' => [ 'name' => 'IssueCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IssueCertificateRequest', ], 'output' => [ 'shape' => 'IssueCertificateResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidArgsException', ], [ 'shape' => 'MalformedCSRException', ], ], 'idempotent' => true, ], 'ListCertificateAuthorities' => [ 'name' => 'ListCertificateAuthorities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCertificateAuthoritiesRequest', ], 'output' => [ 'shape' => 'ListCertificateAuthoritiesResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], ], ], 'ListPermissions' => [ 'name' => 'ListPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPermissionsRequest', ], 'output' => [ 'shape' => 'ListPermissionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'RequestFailedException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'PutPolicy' => [ 'name' => 'PutPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutPolicyRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidPolicyException', ], [ 'shape' => 'LockoutPreventedException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'RestoreCertificateAuthority' => [ 'name' => 'RestoreCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidArnException', ], ], ], 'RevokeCertificate' => [ 'name' => 'RevokeCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeCertificateRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'RequestAlreadyProcessedException', ], [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], ], ], 'TagCertificateAuthority' => [ 'name' => 'TagCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidTagException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'UntagCertificateAuthority' => [ 'name' => 'UntagCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidTagException', ], ], ], 'UpdateCertificateAuthority' => [ 'name' => 'UpdateCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgsException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidPolicyException', ], ], ], ], 'shapes' => [ 'ASN1PrintableString64' => [ 'type' => 'string', 'max' => 64, 'min' => 0, 'pattern' => '[a-zA-Z0-9\'()+-.?:/= ]*', ], 'ASN1Subject' => [ 'type' => 'structure', 'members' => [ 'Country' => [ 'shape' => 'CountryCodeString', ], 'Organization' => [ 'shape' => 'String64', ], 'OrganizationalUnit' => [ 'shape' => 'String64', ], 'DistinguishedNameQualifier' => [ 'shape' => 'ASN1PrintableString64', ], 'State' => [ 'shape' => 'String128', ], 'CommonName' => [ 'shape' => 'String64', ], 'SerialNumber' => [ 'shape' => 'ASN1PrintableString64', ], 'Locality' => [ 'shape' => 'String128', ], 'Title' => [ 'shape' => 'String64', ], 'Surname' => [ 'shape' => 'String40', ], 'GivenName' => [ 'shape' => 'String16', ], 'Initials' => [ 'shape' => 'String5', ], 'Pseudonym' => [ 'shape' => 'String128', ], 'GenerationQualifier' => [ 'shape' => 'String3', ], 'CustomAttributes' => [ 'shape' => 'CustomAttributeList', ], ], ], 'AWSPolicy' => [ 'type' => 'string', 'max' => 20480, 'min' => 1, 'pattern' => '[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+', ], 'AccessDescription' => [ 'type' => 'structure', 'required' => [ 'AccessMethod', 'AccessLocation', ], 'members' => [ 'AccessMethod' => [ 'shape' => 'AccessMethod', ], 'AccessLocation' => [ 'shape' => 'GeneralName', ], ], 'box' => true, ], 'AccessDescriptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessDescription', ], ], 'AccessMethod' => [ 'type' => 'structure', 'members' => [ 'CustomObjectIdentifier' => [ 'shape' => 'CustomObjectIdentifier', ], 'AccessMethodType' => [ 'shape' => 'AccessMethodType', ], ], ], 'AccessMethodType' => [ 'type' => 'string', 'enum' => [ 'CA_REPOSITORY', 'RESOURCE_PKI_MANIFEST', 'RESOURCE_PKI_NOTIFY', ], ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '[0-9]+', ], 'ActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionType', ], 'max' => 3, 'min' => 1, ], 'ActionType' => [ 'type' => 'string', 'enum' => [ 'IssueCertificate', 'GetCertificate', 'ListPermissions', ], ], 'ApiPassthrough' => [ 'type' => 'structure', 'members' => [ 'Extensions' => [ 'shape' => 'Extensions', ], 'Subject' => [ 'shape' => 'ASN1Subject', ], ], ], 'Arn' => [ 'type' => 'string', 'max' => 200, 'min' => 5, 'pattern' => 'arn:[\\w+=/,.@-]+:acm-pca:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*', ], 'AuditReportId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}', ], 'AuditReportResponseFormat' => [ 'type' => 'string', 'enum' => [ 'JSON', 'CSV', ], ], 'AuditReportStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'SUCCESS', 'FAILED', ], ], 'Base64String1To4096' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$', ], 'Boolean' => [ 'type' => 'boolean', ], 'CertificateAuthorities' => [ 'type' => 'list', 'member' => [ 'shape' => 'CertificateAuthority', ], ], 'CertificateAuthority' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'OwnerAccount' => [ 'shape' => 'AccountId', ], 'CreatedAt' => [ 'shape' => 'TStamp', ], 'LastStateChangeAt' => [ 'shape' => 'TStamp', ], 'Type' => [ 'shape' => 'CertificateAuthorityType', ], 'Serial' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'CertificateAuthorityStatus', ], 'NotBefore' => [ 'shape' => 'TStamp', ], 'NotAfter' => [ 'shape' => 'TStamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CertificateAuthorityConfiguration' => [ 'shape' => 'CertificateAuthorityConfiguration', ], 'RevocationConfiguration' => [ 'shape' => 'RevocationConfiguration', ], 'RestorableUntil' => [ 'shape' => 'TStamp', ], 'KeyStorageSecurityStandard' => [ 'shape' => 'KeyStorageSecurityStandard', ], 'UsageMode' => [ 'shape' => 'CertificateAuthorityUsageMode', ], ], ], 'CertificateAuthorityConfiguration' => [ 'type' => 'structure', 'required' => [ 'KeyAlgorithm', 'SigningAlgorithm', 'Subject', ], 'members' => [ 'KeyAlgorithm' => [ 'shape' => 'KeyAlgorithm', ], 'SigningAlgorithm' => [ 'shape' => 'SigningAlgorithm', ], 'Subject' => [ 'shape' => 'ASN1Subject', ], 'CsrExtensions' => [ 'shape' => 'CsrExtensions', ], ], ], 'CertificateAuthorityStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'PENDING_CERTIFICATE', 'ACTIVE', 'DELETED', 'DISABLED', 'EXPIRED', 'FAILED', ], ], 'CertificateAuthorityType' => [ 'type' => 'string', 'enum' => [ 'ROOT', 'SUBORDINATE', ], ], 'CertificateAuthorityUsageMode' => [ 'type' => 'string', 'enum' => [ 'GENERAL_PURPOSE', 'SHORT_LIVED_CERTIFICATE', ], ], 'CertificateBody' => [ 'type' => 'string', ], 'CertificateBodyBlob' => [ 'type' => 'blob', 'max' => 32768, 'min' => 1, ], 'CertificateChain' => [ 'type' => 'string', ], 'CertificateChainBlob' => [ 'type' => 'blob', 'max' => 2097152, 'min' => 0, ], 'CertificateMismatchException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'CertificatePolicyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicyInformation', ], 'max' => 20, 'min' => 1, ], 'CnameString' => [ 'type' => 'string', 'max' => 253, 'min' => 0, 'pattern' => '^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()\']*$', ], 'ConcurrentModificationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'CountryCodeString' => [ 'type' => 'string', 'max' => 2, 'min' => 2, 'pattern' => '[A-Za-z]{2}', ], 'CreateCertificateAuthorityAuditReportRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'S3BucketName', 'AuditReportResponseFormat', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'AuditReportResponseFormat' => [ 'shape' => 'AuditReportResponseFormat', ], ], ], 'CreateCertificateAuthorityAuditReportResponse' => [ 'type' => 'structure', 'members' => [ 'AuditReportId' => [ 'shape' => 'AuditReportId', ], 'S3Key' => [ 'shape' => 'S3Key', ], ], ], 'CreateCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityConfiguration', 'CertificateAuthorityType', ], 'members' => [ 'CertificateAuthorityConfiguration' => [ 'shape' => 'CertificateAuthorityConfiguration', ], 'RevocationConfiguration' => [ 'shape' => 'RevocationConfiguration', ], 'CertificateAuthorityType' => [ 'shape' => 'CertificateAuthorityType', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', ], 'KeyStorageSecurityStandard' => [ 'shape' => 'KeyStorageSecurityStandard', ], 'Tags' => [ 'shape' => 'TagList', ], 'UsageMode' => [ 'shape' => 'CertificateAuthorityUsageMode', ], ], ], 'CreateCertificateAuthorityResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'CreatePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Principal', 'Actions', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Principal' => [ 'shape' => 'Principal', ], 'SourceAccount' => [ 'shape' => 'AccountId', ], 'Actions' => [ 'shape' => 'ActionList', ], ], ], 'CrlConfiguration' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', 'box' => true, ], 'ExpirationInDays' => [ 'shape' => 'Integer1To5000', 'box' => true, ], 'CustomCname' => [ 'shape' => 'CnameString', ], 'S3BucketName' => [ 'shape' => 'S3BucketName3To255', ], 'S3ObjectAcl' => [ 'shape' => 'S3ObjectAcl', ], 'CrlDistributionPointExtensionConfiguration' => [ 'shape' => 'CrlDistributionPointExtensionConfiguration', ], ], ], 'CrlDistributionPointExtensionConfiguration' => [ 'type' => 'structure', 'required' => [ 'OmitExtension', ], 'members' => [ 'OmitExtension' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'CsrBlob' => [ 'type' => 'blob', 'max' => 32768, 'min' => 1, ], 'CsrBody' => [ 'type' => 'string', ], 'CsrExtensions' => [ 'type' => 'structure', 'members' => [ 'KeyUsage' => [ 'shape' => 'KeyUsage', ], 'SubjectInformationAccess' => [ 'shape' => 'AccessDescriptionList', ], ], ], 'CustomAttribute' => [ 'type' => 'structure', 'required' => [ 'ObjectIdentifier', 'Value', ], 'members' => [ 'ObjectIdentifier' => [ 'shape' => 'CustomObjectIdentifier', ], 'Value' => [ 'shape' => 'String1To256', ], ], ], 'CustomAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomAttribute', ], 'max' => 150, 'min' => 1, ], 'CustomExtension' => [ 'type' => 'structure', 'required' => [ 'ObjectIdentifier', 'Value', ], 'members' => [ 'ObjectIdentifier' => [ 'shape' => 'CustomObjectIdentifier', ], 'Value' => [ 'shape' => 'Base64String1To4096', ], 'Critical' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'CustomExtensionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomExtension', ], 'max' => 150, 'min' => 1, ], 'CustomObjectIdentifier' => [ 'type' => 'string', 'max' => 64, 'min' => 0, 'pattern' => '^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$', ], 'DeleteCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'PermanentDeletionTimeInDays' => [ 'shape' => 'PermanentDeletionTimeInDays', ], ], ], 'DeletePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Principal', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Principal' => [ 'shape' => 'Principal', ], 'SourceAccount' => [ 'shape' => 'AccountId', ], ], ], 'DeletePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeCertificateAuthorityAuditReportRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'AuditReportId', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'AuditReportId' => [ 'shape' => 'AuditReportId', ], ], ], 'DescribeCertificateAuthorityAuditReportResponse' => [ 'type' => 'structure', 'members' => [ 'AuditReportStatus' => [ 'shape' => 'AuditReportStatus', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Key' => [ 'shape' => 'S3Key', ], 'CreatedAt' => [ 'shape' => 'TStamp', ], ], ], 'DescribeCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeCertificateAuthorityResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthority' => [ 'shape' => 'CertificateAuthority', ], ], ], 'EdiPartyName' => [ 'type' => 'structure', 'required' => [ 'PartyName', ], 'members' => [ 'PartyName' => [ 'shape' => 'String256', ], 'NameAssigner' => [ 'shape' => 'String256', ], ], ], 'ExtendedKeyUsage' => [ 'type' => 'structure', 'members' => [ 'ExtendedKeyUsageType' => [ 'shape' => 'ExtendedKeyUsageType', ], 'ExtendedKeyUsageObjectIdentifier' => [ 'shape' => 'CustomObjectIdentifier', ], ], ], 'ExtendedKeyUsageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExtendedKeyUsage', ], 'max' => 20, 'min' => 1, ], 'ExtendedKeyUsageType' => [ 'type' => 'string', 'enum' => [ 'SERVER_AUTH', 'CLIENT_AUTH', 'CODE_SIGNING', 'EMAIL_PROTECTION', 'TIME_STAMPING', 'OCSP_SIGNING', 'SMART_CARD_LOGIN', 'DOCUMENT_SIGNING', 'CERTIFICATE_TRANSPARENCY', ], ], 'Extensions' => [ 'type' => 'structure', 'members' => [ 'CertificatePolicies' => [ 'shape' => 'CertificatePolicyList', ], 'ExtendedKeyUsage' => [ 'shape' => 'ExtendedKeyUsageList', ], 'KeyUsage' => [ 'shape' => 'KeyUsage', ], 'SubjectAlternativeNames' => [ 'shape' => 'GeneralNameList', ], 'CustomExtensions' => [ 'shape' => 'CustomExtensionList', ], ], ], 'FailureReason' => [ 'type' => 'string', 'enum' => [ 'REQUEST_TIMED_OUT', 'UNSUPPORTED_ALGORITHM', 'OTHER', ], ], 'GeneralName' => [ 'type' => 'structure', 'members' => [ 'OtherName' => [ 'shape' => 'OtherName', ], 'Rfc822Name' => [ 'shape' => 'String256', ], 'DnsName' => [ 'shape' => 'String253', ], 'DirectoryName' => [ 'shape' => 'ASN1Subject', ], 'EdiPartyName' => [ 'shape' => 'EdiPartyName', ], 'UniformResourceIdentifier' => [ 'shape' => 'String253', ], 'IpAddress' => [ 'shape' => 'String39', ], 'RegisteredId' => [ 'shape' => 'CustomObjectIdentifier', ], ], ], 'GeneralNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GeneralName', ], 'max' => 150, 'min' => 1, ], 'GetCertificateAuthorityCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'GetCertificateAuthorityCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'Certificate' => [ 'shape' => 'CertificateBody', ], 'CertificateChain' => [ 'shape' => 'CertificateChain', ], ], ], 'GetCertificateAuthorityCsrRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'GetCertificateAuthorityCsrResponse' => [ 'type' => 'structure', 'members' => [ 'Csr' => [ 'shape' => 'CsrBody', ], ], ], 'GetCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'CertificateArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'CertificateArn' => [ 'shape' => 'Arn', ], ], ], 'GetCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'Certificate' => [ 'shape' => 'CertificateBody', ], 'CertificateChain' => [ 'shape' => 'CertificateChain', ], ], ], 'GetPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], ], ], 'GetPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'AWSPolicy', ], ], ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*', ], 'ImportCertificateAuthorityCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Certificate', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Certificate' => [ 'shape' => 'CertificateBodyBlob', ], 'CertificateChain' => [ 'shape' => 'CertificateChainBlob', ], ], ], 'Integer1To5000' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'InvalidArgsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidArnException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidPolicyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidStateException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidTagException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'IssueCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Csr', 'SigningAlgorithm', 'Validity', ], 'members' => [ 'ApiPassthrough' => [ 'shape' => 'ApiPassthrough', ], 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Csr' => [ 'shape' => 'CsrBlob', ], 'SigningAlgorithm' => [ 'shape' => 'SigningAlgorithm', ], 'TemplateArn' => [ 'shape' => 'Arn', ], 'Validity' => [ 'shape' => 'Validity', ], 'ValidityNotBefore' => [ 'shape' => 'Validity', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', ], ], ], 'IssueCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateArn' => [ 'shape' => 'Arn', ], ], ], 'KeyAlgorithm' => [ 'type' => 'string', 'enum' => [ 'RSA_2048', 'RSA_4096', 'EC_prime256v1', 'EC_secp384r1', ], ], 'KeyStorageSecurityStandard' => [ 'type' => 'string', 'enum' => [ 'FIPS_140_2_LEVEL_2_OR_HIGHER', 'FIPS_140_2_LEVEL_3_OR_HIGHER', ], ], 'KeyUsage' => [ 'type' => 'structure', 'members' => [ 'DigitalSignature' => [ 'shape' => 'Boolean', ], 'NonRepudiation' => [ 'shape' => 'Boolean', ], 'KeyEncipherment' => [ 'shape' => 'Boolean', ], 'DataEncipherment' => [ 'shape' => 'Boolean', ], 'KeyAgreement' => [ 'shape' => 'Boolean', ], 'KeyCertSign' => [ 'shape' => 'Boolean', ], 'CRLSign' => [ 'shape' => 'Boolean', ], 'EncipherOnly' => [ 'shape' => 'Boolean', ], 'DecipherOnly' => [ 'shape' => 'Boolean', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ListCertificateAuthoritiesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ResourceOwner' => [ 'shape' => 'ResourceOwner', ], ], ], 'ListCertificateAuthoritiesResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorities' => [ 'shape' => 'CertificateAuthorities', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'PermissionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'LockoutPreventedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MalformedCSRException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MalformedCertificateException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'NextToken' => [ 'type' => 'string', 'max' => 43739, 'min' => 1, ], 'OcspConfiguration' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', 'box' => true, ], 'OcspCustomCname' => [ 'shape' => 'CnameString', ], ], ], 'OtherName' => [ 'type' => 'structure', 'required' => [ 'TypeId', 'Value', ], 'members' => [ 'TypeId' => [ 'shape' => 'CustomObjectIdentifier', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'PermanentDeletionTimeInDays' => [ 'type' => 'integer', 'max' => 30, 'min' => 7, ], 'Permission' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'CreatedAt' => [ 'shape' => 'TStamp', ], 'Principal' => [ 'shape' => 'Principal', ], 'SourceAccount' => [ 'shape' => 'AccountId', ], 'Actions' => [ 'shape' => 'ActionList', ], 'Policy' => [ 'shape' => 'AWSPolicy', ], ], ], 'PermissionAlreadyExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'PermissionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Permission', ], 'min' => 0, ], 'PolicyInformation' => [ 'type' => 'structure', 'required' => [ 'CertPolicyId', ], 'members' => [ 'CertPolicyId' => [ 'shape' => 'CustomObjectIdentifier', ], 'PolicyQualifiers' => [ 'shape' => 'PolicyQualifierInfoList', ], ], ], 'PolicyQualifierId' => [ 'type' => 'string', 'enum' => [ 'CPS', ], ], 'PolicyQualifierInfo' => [ 'type' => 'structure', 'required' => [ 'PolicyQualifierId', 'Qualifier', ], 'members' => [ 'PolicyQualifierId' => [ 'shape' => 'PolicyQualifierId', ], 'Qualifier' => [ 'shape' => 'Qualifier', ], ], ], 'PolicyQualifierInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicyQualifierInfo', ], 'max' => 20, 'min' => 1, ], 'PositiveLong' => [ 'type' => 'long', 'min' => 1, ], 'Principal' => [ 'type' => 'string', 'max' => 128, 'min' => 0, 'pattern' => '^[^*]+$', ], 'PutPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Policy', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], 'Policy' => [ 'shape' => 'AWSPolicy', ], ], ], 'Qualifier' => [ 'type' => 'structure', 'required' => [ 'CpsUri', ], 'members' => [ 'CpsUri' => [ 'shape' => 'String256', ], ], ], 'RequestAlreadyProcessedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'RequestFailedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'RequestInProgressException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceOwner' => [ 'type' => 'string', 'enum' => [ 'SELF', 'OTHER_ACCOUNTS', ], ], 'RestoreCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'RevocationConfiguration' => [ 'type' => 'structure', 'members' => [ 'CrlConfiguration' => [ 'shape' => 'CrlConfiguration', ], 'OcspConfiguration' => [ 'shape' => 'OcspConfiguration', ], ], ], 'RevocationReason' => [ 'type' => 'string', 'enum' => [ 'UNSPECIFIED', 'KEY_COMPROMISE', 'CERTIFICATE_AUTHORITY_COMPROMISE', 'AFFILIATION_CHANGED', 'SUPERSEDED', 'CESSATION_OF_OPERATION', 'PRIVILEGE_WITHDRAWN', 'A_A_COMPROMISE', ], ], 'RevokeCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'CertificateSerial', 'RevocationReason', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'CertificateSerial' => [ 'shape' => 'String128', ], 'RevocationReason' => [ 'shape' => 'RevocationReason', ], ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, ], 'S3BucketName3To255' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '^[-a-zA-Z0-9._/]+$', ], 'S3Key' => [ 'type' => 'string', 'max' => 1024, ], 'S3ObjectAcl' => [ 'type' => 'string', 'enum' => [ 'PUBLIC_READ', 'BUCKET_OWNER_FULL_CONTROL', ], ], 'SigningAlgorithm' => [ 'type' => 'string', 'enum' => [ 'SHA256WITHECDSA', 'SHA384WITHECDSA', 'SHA512WITHECDSA', 'SHA256WITHRSA', 'SHA384WITHRSA', 'SHA512WITHRSA', ], ], 'String' => [ 'type' => 'string', ], 'String128' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'String16' => [ 'type' => 'string', 'max' => 16, 'min' => 0, ], 'String1To256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'String253' => [ 'type' => 'string', 'max' => 253, 'min' => 0, ], 'String256' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'String3' => [ 'type' => 'string', 'max' => 3, 'min' => 0, ], 'String39' => [ 'type' => 'string', 'max' => 39, 'min' => 0, ], 'String40' => [ 'type' => 'string', 'max' => 40, 'min' => 0, ], 'String5' => [ 'type' => 'string', 'max' => 5, 'min' => 0, ], 'String64' => [ 'type' => 'string', 'max' => 64, 'min' => 0, ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Tags', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 1, ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'UntagCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Tags', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'UpdateCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'RevocationConfiguration' => [ 'shape' => 'RevocationConfiguration', ], 'Status' => [ 'shape' => 'CertificateAuthorityStatus', ], ], ], 'Validity' => [ 'type' => 'structure', 'required' => [ 'Value', 'Type', ], 'members' => [ 'Value' => [ 'shape' => 'PositiveLong', 'box' => true, ], 'Type' => [ 'shape' => 'ValidityPeriodType', ], ], ], 'ValidityPeriodType' => [ 'type' => 'string', 'enum' => [ 'END_DATE', 'ABSOLUTE', 'DAYS', 'MONTHS', 'YEARS', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2017-08-22', 'endpointPrefix' => 'acm-pca', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'ACM-PCA', 'serviceFullName' => 'AWS Certificate Manager Private Certificate Authority', 'serviceId' => 'ACM PCA', 'signatureVersion' => 'v4', 'targetPrefix' => 'ACMPrivateCA', 'uid' => 'acm-pca-2017-08-22', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'CreateCertificateAuthority' => [ 'name' => 'CreateCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCertificateAuthorityRequest', ], 'output' => [ 'shape' => 'CreateCertificateAuthorityResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgsException', ], [ 'shape' => 'InvalidPolicyException', ], [ 'shape' => 'InvalidTagException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'CreateCertificateAuthorityAuditReport' => [ 'name' => 'CreateCertificateAuthorityAuditReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCertificateAuthorityAuditReportRequest', ], 'output' => [ 'shape' => 'CreateCertificateAuthorityAuditReportResponse', ], 'errors' => [ [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidArgsException', ], [ 'shape' => 'InvalidStateException', ], ], 'idempotent' => true, ], 'CreatePermission' => [ 'name' => 'CreatePermission', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePermissionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'PermissionAlreadyExistsException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'RequestFailedException', ], ], ], 'DeleteCertificateAuthority' => [ 'name' => 'DeleteCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'DeletePermission' => [ 'name' => 'DeletePermission', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePermissionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'RequestFailedException', ], ], ], 'DeletePolicy' => [ 'name' => 'DeletePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeletePolicyRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'LockoutPreventedException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DescribeCertificateAuthority' => [ 'name' => 'DescribeCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificateAuthorityRequest', ], 'output' => [ 'shape' => 'DescribeCertificateAuthorityResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], ], ], 'DescribeCertificateAuthorityAuditReport' => [ 'name' => 'DescribeCertificateAuthorityAuditReport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCertificateAuthorityAuditReportRequest', ], 'output' => [ 'shape' => 'DescribeCertificateAuthorityAuditReportResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidArgsException', ], ], ], 'GetCertificate' => [ 'name' => 'GetCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCertificateRequest', ], 'output' => [ 'shape' => 'GetCertificateResponse', ], 'errors' => [ [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'GetCertificateAuthorityCertificate' => [ 'name' => 'GetCertificateAuthorityCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCertificateAuthorityCertificateRequest', ], 'output' => [ 'shape' => 'GetCertificateAuthorityCertificateResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidArnException', ], ], ], 'GetCertificateAuthorityCsr' => [ 'name' => 'GetCertificateAuthorityCsr', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetCertificateAuthorityCsrRequest', ], 'output' => [ 'shape' => 'GetCertificateAuthorityCsrResponse', ], 'errors' => [ [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'GetPolicy' => [ 'name' => 'GetPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetPolicyRequest', ], 'output' => [ 'shape' => 'GetPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ImportCertificateAuthorityCertificate' => [ 'name' => 'ImportCertificateAuthorityCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ImportCertificateAuthorityCertificateRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'MalformedCertificateException', ], [ 'shape' => 'CertificateMismatchException', ], ], ], 'IssueCertificate' => [ 'name' => 'IssueCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IssueCertificateRequest', ], 'output' => [ 'shape' => 'IssueCertificateResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidArgsException', ], [ 'shape' => 'MalformedCSRException', ], ], 'idempotent' => true, ], 'ListCertificateAuthorities' => [ 'name' => 'ListCertificateAuthorities', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListCertificateAuthoritiesRequest', ], 'output' => [ 'shape' => 'ListCertificateAuthoritiesResponse', ], 'errors' => [ [ 'shape' => 'InvalidNextTokenException', ], ], ], 'ListPermissions' => [ 'name' => 'ListPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListPermissionsRequest', ], 'output' => [ 'shape' => 'ListPermissionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidNextTokenException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'RequestFailedException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], ], ], 'PutPolicy' => [ 'name' => 'PutPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutPolicyRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidPolicyException', ], [ 'shape' => 'LockoutPreventedException', ], [ 'shape' => 'RequestFailedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'RestoreCertificateAuthority' => [ 'name' => 'RestoreCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidArnException', ], ], ], 'RevokeCertificate' => [ 'name' => 'RevokeCertificate', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeCertificateRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'RequestAlreadyProcessedException', ], [ 'shape' => 'RequestInProgressException', ], [ 'shape' => 'RequestFailedException', ], ], ], 'TagCertificateAuthority' => [ 'name' => 'TagCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidTagException', ], [ 'shape' => 'TooManyTagsException', ], ], ], 'UntagCertificateAuthority' => [ 'name' => 'UntagCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidTagException', ], ], ], 'UpdateCertificateAuthority' => [ 'name' => 'UpdateCertificateAuthority', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateCertificateAuthorityRequest', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgsException', ], [ 'shape' => 'InvalidArnException', ], [ 'shape' => 'InvalidStateException', ], [ 'shape' => 'InvalidPolicyException', ], ], ], ], 'shapes' => [ 'ASN1PrintableString64' => [ 'type' => 'string', 'max' => 64, 'min' => 0, 'pattern' => '[a-zA-Z0-9\'()+-.?:/= ]*', ], 'ASN1Subject' => [ 'type' => 'structure', 'members' => [ 'Country' => [ 'shape' => 'CountryCodeString', ], 'Organization' => [ 'shape' => 'String64', ], 'OrganizationalUnit' => [ 'shape' => 'String64', ], 'DistinguishedNameQualifier' => [ 'shape' => 'ASN1PrintableString64', ], 'State' => [ 'shape' => 'String128', ], 'CommonName' => [ 'shape' => 'String64', ], 'SerialNumber' => [ 'shape' => 'ASN1PrintableString64', ], 'Locality' => [ 'shape' => 'String128', ], 'Title' => [ 'shape' => 'String64', ], 'Surname' => [ 'shape' => 'String40', ], 'GivenName' => [ 'shape' => 'String16', ], 'Initials' => [ 'shape' => 'String5', ], 'Pseudonym' => [ 'shape' => 'String128', ], 'GenerationQualifier' => [ 'shape' => 'String3', ], 'CustomAttributes' => [ 'shape' => 'CustomAttributeList', ], ], ], 'AWSPolicy' => [ 'type' => 'string', 'max' => 20480, 'min' => 1, 'pattern' => '[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+', ], 'AccessDescription' => [ 'type' => 'structure', 'required' => [ 'AccessMethod', 'AccessLocation', ], 'members' => [ 'AccessMethod' => [ 'shape' => 'AccessMethod', ], 'AccessLocation' => [ 'shape' => 'GeneralName', ], ], 'box' => true, ], 'AccessDescriptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessDescription', ], ], 'AccessMethod' => [ 'type' => 'structure', 'members' => [ 'CustomObjectIdentifier' => [ 'shape' => 'CustomObjectIdentifier', ], 'AccessMethodType' => [ 'shape' => 'AccessMethodType', ], ], ], 'AccessMethodType' => [ 'type' => 'string', 'enum' => [ 'CA_REPOSITORY', 'RESOURCE_PKI_MANIFEST', 'RESOURCE_PKI_NOTIFY', ], ], 'AccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '[0-9]+', ], 'ActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionType', ], 'max' => 3, 'min' => 1, ], 'ActionType' => [ 'type' => 'string', 'enum' => [ 'IssueCertificate', 'GetCertificate', 'ListPermissions', ], ], 'ApiPassthrough' => [ 'type' => 'structure', 'members' => [ 'Extensions' => [ 'shape' => 'Extensions', ], 'Subject' => [ 'shape' => 'ASN1Subject', ], ], ], 'Arn' => [ 'type' => 'string', 'max' => 200, 'min' => 5, 'pattern' => 'arn:[\\w+=/,.@-]+:acm-pca:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*', ], 'AuditReportId' => [ 'type' => 'string', 'max' => 36, 'min' => 36, 'pattern' => '[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}', ], 'AuditReportResponseFormat' => [ 'type' => 'string', 'enum' => [ 'JSON', 'CSV', ], ], 'AuditReportStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'SUCCESS', 'FAILED', ], ], 'Base64String1To4096' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$', ], 'Boolean' => [ 'type' => 'boolean', ], 'CertificateAuthorities' => [ 'type' => 'list', 'member' => [ 'shape' => 'CertificateAuthority', ], ], 'CertificateAuthority' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'Arn', ], 'OwnerAccount' => [ 'shape' => 'AccountId', ], 'CreatedAt' => [ 'shape' => 'TStamp', ], 'LastStateChangeAt' => [ 'shape' => 'TStamp', ], 'Type' => [ 'shape' => 'CertificateAuthorityType', ], 'Serial' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'CertificateAuthorityStatus', ], 'NotBefore' => [ 'shape' => 'TStamp', ], 'NotAfter' => [ 'shape' => 'TStamp', ], 'FailureReason' => [ 'shape' => 'FailureReason', ], 'CertificateAuthorityConfiguration' => [ 'shape' => 'CertificateAuthorityConfiguration', ], 'RevocationConfiguration' => [ 'shape' => 'RevocationConfiguration', ], 'RestorableUntil' => [ 'shape' => 'TStamp', ], 'KeyStorageSecurityStandard' => [ 'shape' => 'KeyStorageSecurityStandard', ], 'UsageMode' => [ 'shape' => 'CertificateAuthorityUsageMode', ], ], ], 'CertificateAuthorityConfiguration' => [ 'type' => 'structure', 'required' => [ 'KeyAlgorithm', 'SigningAlgorithm', 'Subject', ], 'members' => [ 'KeyAlgorithm' => [ 'shape' => 'KeyAlgorithm', ], 'SigningAlgorithm' => [ 'shape' => 'SigningAlgorithm', ], 'Subject' => [ 'shape' => 'ASN1Subject', ], 'CsrExtensions' => [ 'shape' => 'CsrExtensions', ], ], ], 'CertificateAuthorityStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'PENDING_CERTIFICATE', 'ACTIVE', 'DELETED', 'DISABLED', 'EXPIRED', 'FAILED', ], ], 'CertificateAuthorityType' => [ 'type' => 'string', 'enum' => [ 'ROOT', 'SUBORDINATE', ], ], 'CertificateAuthorityUsageMode' => [ 'type' => 'string', 'enum' => [ 'GENERAL_PURPOSE', 'SHORT_LIVED_CERTIFICATE', ], ], 'CertificateBody' => [ 'type' => 'string', ], 'CertificateBodyBlob' => [ 'type' => 'blob', 'max' => 32768, 'min' => 1, ], 'CertificateChain' => [ 'type' => 'string', ], 'CertificateChainBlob' => [ 'type' => 'blob', 'max' => 2097152, 'min' => 0, ], 'CertificateMismatchException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'CertificatePolicyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicyInformation', ], 'max' => 20, 'min' => 1, ], 'CnameString' => [ 'type' => 'string', 'max' => 253, 'min' => 0, 'pattern' => '^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()\']*$', ], 'ConcurrentModificationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'CountryCodeString' => [ 'type' => 'string', 'max' => 2, 'min' => 2, 'pattern' => '[A-Za-z]{2}', ], 'CreateCertificateAuthorityAuditReportRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'S3BucketName', 'AuditReportResponseFormat', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'AuditReportResponseFormat' => [ 'shape' => 'AuditReportResponseFormat', ], ], ], 'CreateCertificateAuthorityAuditReportResponse' => [ 'type' => 'structure', 'members' => [ 'AuditReportId' => [ 'shape' => 'AuditReportId', ], 'S3Key' => [ 'shape' => 'S3Key', ], ], ], 'CreateCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityConfiguration', 'CertificateAuthorityType', ], 'members' => [ 'CertificateAuthorityConfiguration' => [ 'shape' => 'CertificateAuthorityConfiguration', ], 'RevocationConfiguration' => [ 'shape' => 'RevocationConfiguration', ], 'CertificateAuthorityType' => [ 'shape' => 'CertificateAuthorityType', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', ], 'KeyStorageSecurityStandard' => [ 'shape' => 'KeyStorageSecurityStandard', ], 'Tags' => [ 'shape' => 'TagList', ], 'UsageMode' => [ 'shape' => 'CertificateAuthorityUsageMode', ], ], ], 'CreateCertificateAuthorityResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'CreatePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Principal', 'Actions', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Principal' => [ 'shape' => 'Principal', ], 'SourceAccount' => [ 'shape' => 'AccountId', ], 'Actions' => [ 'shape' => 'ActionList', ], ], ], 'CrlConfiguration' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', 'box' => true, ], 'ExpirationInDays' => [ 'shape' => 'Integer1To5000', 'box' => true, ], 'CustomCname' => [ 'shape' => 'CnameString', ], 'S3BucketName' => [ 'shape' => 'S3BucketName3To255', ], 'S3ObjectAcl' => [ 'shape' => 'S3ObjectAcl', ], 'CrlDistributionPointExtensionConfiguration' => [ 'shape' => 'CrlDistributionPointExtensionConfiguration', ], ], ], 'CrlDistributionPointExtensionConfiguration' => [ 'type' => 'structure', 'required' => [ 'OmitExtension', ], 'members' => [ 'OmitExtension' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'CsrBlob' => [ 'type' => 'blob', 'max' => 32768, 'min' => 1, ], 'CsrBody' => [ 'type' => 'string', ], 'CsrExtensions' => [ 'type' => 'structure', 'members' => [ 'KeyUsage' => [ 'shape' => 'KeyUsage', ], 'SubjectInformationAccess' => [ 'shape' => 'AccessDescriptionList', ], ], ], 'CustomAttribute' => [ 'type' => 'structure', 'required' => [ 'ObjectIdentifier', 'Value', ], 'members' => [ 'ObjectIdentifier' => [ 'shape' => 'CustomObjectIdentifier', ], 'Value' => [ 'shape' => 'String1To256', ], ], ], 'CustomAttributeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomAttribute', ], 'max' => 150, 'min' => 1, ], 'CustomExtension' => [ 'type' => 'structure', 'required' => [ 'ObjectIdentifier', 'Value', ], 'members' => [ 'ObjectIdentifier' => [ 'shape' => 'CustomObjectIdentifier', ], 'Value' => [ 'shape' => 'Base64String1To4096', ], 'Critical' => [ 'shape' => 'Boolean', 'box' => true, ], ], ], 'CustomExtensionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomExtension', ], 'max' => 150, 'min' => 1, ], 'CustomObjectIdentifier' => [ 'type' => 'string', 'max' => 64, 'min' => 0, 'pattern' => '^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$', ], 'DeleteCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'PermanentDeletionTimeInDays' => [ 'shape' => 'PermanentDeletionTimeInDays', ], ], ], 'DeletePermissionRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Principal', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Principal' => [ 'shape' => 'Principal', ], 'SourceAccount' => [ 'shape' => 'AccountId', ], ], ], 'DeletePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeCertificateAuthorityAuditReportRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'AuditReportId', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'AuditReportId' => [ 'shape' => 'AuditReportId', ], ], ], 'DescribeCertificateAuthorityAuditReportResponse' => [ 'type' => 'structure', 'members' => [ 'AuditReportStatus' => [ 'shape' => 'AuditReportStatus', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Key' => [ 'shape' => 'S3Key', ], 'CreatedAt' => [ 'shape' => 'TStamp', ], ], ], 'DescribeCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'DescribeCertificateAuthorityResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthority' => [ 'shape' => 'CertificateAuthority', ], ], ], 'EdiPartyName' => [ 'type' => 'structure', 'required' => [ 'PartyName', ], 'members' => [ 'PartyName' => [ 'shape' => 'String256', ], 'NameAssigner' => [ 'shape' => 'String256', ], ], ], 'ExtendedKeyUsage' => [ 'type' => 'structure', 'members' => [ 'ExtendedKeyUsageType' => [ 'shape' => 'ExtendedKeyUsageType', ], 'ExtendedKeyUsageObjectIdentifier' => [ 'shape' => 'CustomObjectIdentifier', ], ], ], 'ExtendedKeyUsageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExtendedKeyUsage', ], 'max' => 20, 'min' => 1, ], 'ExtendedKeyUsageType' => [ 'type' => 'string', 'enum' => [ 'SERVER_AUTH', 'CLIENT_AUTH', 'CODE_SIGNING', 'EMAIL_PROTECTION', 'TIME_STAMPING', 'OCSP_SIGNING', 'SMART_CARD_LOGIN', 'DOCUMENT_SIGNING', 'CERTIFICATE_TRANSPARENCY', ], ], 'Extensions' => [ 'type' => 'structure', 'members' => [ 'CertificatePolicies' => [ 'shape' => 'CertificatePolicyList', ], 'ExtendedKeyUsage' => [ 'shape' => 'ExtendedKeyUsageList', ], 'KeyUsage' => [ 'shape' => 'KeyUsage', ], 'SubjectAlternativeNames' => [ 'shape' => 'GeneralNameList', ], 'CustomExtensions' => [ 'shape' => 'CustomExtensionList', ], ], ], 'FailureReason' => [ 'type' => 'string', 'enum' => [ 'REQUEST_TIMED_OUT', 'UNSUPPORTED_ALGORITHM', 'OTHER', ], ], 'GeneralName' => [ 'type' => 'structure', 'members' => [ 'OtherName' => [ 'shape' => 'OtherName', ], 'Rfc822Name' => [ 'shape' => 'String256', ], 'DnsName' => [ 'shape' => 'String253', ], 'DirectoryName' => [ 'shape' => 'ASN1Subject', ], 'EdiPartyName' => [ 'shape' => 'EdiPartyName', ], 'UniformResourceIdentifier' => [ 'shape' => 'String253', ], 'IpAddress' => [ 'shape' => 'String39', ], 'RegisteredId' => [ 'shape' => 'CustomObjectIdentifier', ], ], ], 'GeneralNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GeneralName', ], 'max' => 150, 'min' => 1, ], 'GetCertificateAuthorityCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'GetCertificateAuthorityCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'Certificate' => [ 'shape' => 'CertificateBody', ], 'CertificateChain' => [ 'shape' => 'CertificateChain', ], ], ], 'GetCertificateAuthorityCsrRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'GetCertificateAuthorityCsrResponse' => [ 'type' => 'structure', 'members' => [ 'Csr' => [ 'shape' => 'CsrBody', ], ], ], 'GetCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'CertificateArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'CertificateArn' => [ 'shape' => 'Arn', ], ], ], 'GetCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'Certificate' => [ 'shape' => 'CertificateBody', ], 'CertificateChain' => [ 'shape' => 'CertificateChain', ], ], ], 'GetPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], ], ], 'GetPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'AWSPolicy', ], ], ], 'IdempotencyToken' => [ 'type' => 'string', 'max' => 36, 'min' => 1, 'pattern' => '[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*', ], 'ImportCertificateAuthorityCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Certificate', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Certificate' => [ 'shape' => 'CertificateBodyBlob', ], 'CertificateChain' => [ 'shape' => 'CertificateChainBlob', ], ], ], 'Integer1To5000' => [ 'type' => 'integer', 'max' => 5000, 'min' => 1, ], 'InvalidArgsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidArnException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidNextTokenException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidPolicyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidStateException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidTagException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'IssueCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Csr', 'SigningAlgorithm', 'Validity', ], 'members' => [ 'ApiPassthrough' => [ 'shape' => 'ApiPassthrough', ], 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Csr' => [ 'shape' => 'CsrBlob', ], 'SigningAlgorithm' => [ 'shape' => 'SigningAlgorithm', ], 'TemplateArn' => [ 'shape' => 'Arn', ], 'Validity' => [ 'shape' => 'Validity', ], 'ValidityNotBefore' => [ 'shape' => 'Validity', ], 'IdempotencyToken' => [ 'shape' => 'IdempotencyToken', ], ], ], 'IssueCertificateResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateArn' => [ 'shape' => 'Arn', ], ], ], 'KeyAlgorithm' => [ 'type' => 'string', 'enum' => [ 'RSA_2048', 'RSA_4096', 'EC_prime256v1', 'EC_secp384r1', 'SM2', ], ], 'KeyStorageSecurityStandard' => [ 'type' => 'string', 'enum' => [ 'FIPS_140_2_LEVEL_2_OR_HIGHER', 'FIPS_140_2_LEVEL_3_OR_HIGHER', 'CCPC_LEVEL_1_OR_HIGHER', ], ], 'KeyUsage' => [ 'type' => 'structure', 'members' => [ 'DigitalSignature' => [ 'shape' => 'Boolean', ], 'NonRepudiation' => [ 'shape' => 'Boolean', ], 'KeyEncipherment' => [ 'shape' => 'Boolean', ], 'DataEncipherment' => [ 'shape' => 'Boolean', ], 'KeyAgreement' => [ 'shape' => 'Boolean', ], 'KeyCertSign' => [ 'shape' => 'Boolean', ], 'CRLSign' => [ 'shape' => 'Boolean', ], 'EncipherOnly' => [ 'shape' => 'Boolean', ], 'DecipherOnly' => [ 'shape' => 'Boolean', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ListCertificateAuthoritiesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'ResourceOwner' => [ 'shape' => 'ResourceOwner', ], ], ], 'ListCertificateAuthoritiesResponse' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorities' => [ 'shape' => 'CertificateAuthorities', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'PermissionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'LockoutPreventedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MalformedCSRException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MalformedCertificateException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'NextToken' => [ 'type' => 'string', 'max' => 43739, 'min' => 1, ], 'OcspConfiguration' => [ 'type' => 'structure', 'required' => [ 'Enabled', ], 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', 'box' => true, ], 'OcspCustomCname' => [ 'shape' => 'CnameString', ], ], ], 'OtherName' => [ 'type' => 'structure', 'required' => [ 'TypeId', 'Value', ], 'members' => [ 'TypeId' => [ 'shape' => 'CustomObjectIdentifier', ], 'Value' => [ 'shape' => 'String256', ], ], ], 'PermanentDeletionTimeInDays' => [ 'type' => 'integer', 'max' => 30, 'min' => 7, ], 'Permission' => [ 'type' => 'structure', 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'CreatedAt' => [ 'shape' => 'TStamp', ], 'Principal' => [ 'shape' => 'Principal', ], 'SourceAccount' => [ 'shape' => 'AccountId', ], 'Actions' => [ 'shape' => 'ActionList', ], 'Policy' => [ 'shape' => 'AWSPolicy', ], ], ], 'PermissionAlreadyExistsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'PermissionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Permission', ], 'min' => 0, ], 'PolicyInformation' => [ 'type' => 'structure', 'required' => [ 'CertPolicyId', ], 'members' => [ 'CertPolicyId' => [ 'shape' => 'CustomObjectIdentifier', ], 'PolicyQualifiers' => [ 'shape' => 'PolicyQualifierInfoList', ], ], ], 'PolicyQualifierId' => [ 'type' => 'string', 'enum' => [ 'CPS', ], ], 'PolicyQualifierInfo' => [ 'type' => 'structure', 'required' => [ 'PolicyQualifierId', 'Qualifier', ], 'members' => [ 'PolicyQualifierId' => [ 'shape' => 'PolicyQualifierId', ], 'Qualifier' => [ 'shape' => 'Qualifier', ], ], ], 'PolicyQualifierInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PolicyQualifierInfo', ], 'max' => 20, 'min' => 1, ], 'PositiveLong' => [ 'type' => 'long', 'min' => 1, ], 'Principal' => [ 'type' => 'string', 'max' => 128, 'min' => 0, 'pattern' => '^[^*]+$', ], 'PutPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Policy', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'Arn', ], 'Policy' => [ 'shape' => 'AWSPolicy', ], ], ], 'Qualifier' => [ 'type' => 'structure', 'required' => [ 'CpsUri', ], 'members' => [ 'CpsUri' => [ 'shape' => 'String256', ], ], ], 'RequestAlreadyProcessedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'RequestFailedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'RequestInProgressException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceOwner' => [ 'type' => 'string', 'enum' => [ 'SELF', 'OTHER_ACCOUNTS', ], ], 'RestoreCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], ], ], 'RevocationConfiguration' => [ 'type' => 'structure', 'members' => [ 'CrlConfiguration' => [ 'shape' => 'CrlConfiguration', ], 'OcspConfiguration' => [ 'shape' => 'OcspConfiguration', ], ], ], 'RevocationReason' => [ 'type' => 'string', 'enum' => [ 'UNSPECIFIED', 'KEY_COMPROMISE', 'CERTIFICATE_AUTHORITY_COMPROMISE', 'AFFILIATION_CHANGED', 'SUPERSEDED', 'CESSATION_OF_OPERATION', 'PRIVILEGE_WITHDRAWN', 'A_A_COMPROMISE', ], ], 'RevokeCertificateRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'CertificateSerial', 'RevocationReason', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'CertificateSerial' => [ 'shape' => 'String128', ], 'RevocationReason' => [ 'shape' => 'RevocationReason', ], ], ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 3, ], 'S3BucketName3To255' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '^[-a-zA-Z0-9._/]+$', ], 'S3Key' => [ 'type' => 'string', 'max' => 1024, ], 'S3ObjectAcl' => [ 'type' => 'string', 'enum' => [ 'PUBLIC_READ', 'BUCKET_OWNER_FULL_CONTROL', ], ], 'SigningAlgorithm' => [ 'type' => 'string', 'enum' => [ 'SHA256WITHECDSA', 'SHA384WITHECDSA', 'SHA512WITHECDSA', 'SHA256WITHRSA', 'SHA384WITHRSA', 'SHA512WITHRSA', 'SM3WITHSM2', ], ], 'String' => [ 'type' => 'string', ], 'String128' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'String16' => [ 'type' => 'string', 'max' => 16, 'min' => 0, ], 'String1To256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'String253' => [ 'type' => 'string', 'max' => 253, 'min' => 0, ], 'String256' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'String3' => [ 'type' => 'string', 'max' => 3, 'min' => 0, ], 'String39' => [ 'type' => 'string', 'max' => 39, 'min' => 0, ], 'String40' => [ 'type' => 'string', 'max' => 40, 'min' => 0, ], 'String5' => [ 'type' => 'string', 'max' => 5, 'min' => 0, ], 'String64' => [ 'type' => 'string', 'max' => 64, 'min' => 0, ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Tags', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 1, ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'UntagCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', 'Tags', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'UpdateCertificateAuthorityRequest' => [ 'type' => 'structure', 'required' => [ 'CertificateAuthorityArn', ], 'members' => [ 'CertificateAuthorityArn' => [ 'shape' => 'Arn', ], 'RevocationConfiguration' => [ 'shape' => 'RevocationConfiguration', ], 'Status' => [ 'shape' => 'CertificateAuthorityStatus', ], ], ], 'Validity' => [ 'type' => 'structure', 'required' => [ 'Value', 'Type', ], 'members' => [ 'Value' => [ 'shape' => 'PositiveLong', 'box' => true, ], 'Type' => [ 'shape' => 'ValidityPeriodType', ], ], ], 'ValidityPeriodType' => [ 'type' => 'string', 'enum' => [ 'END_DATE', 'ABSOLUTE', 'DAYS', 'MONTHS', 'YEARS', ], ], ],]; diff --git a/src/data/cloudhsmv2/2017-04-28/api-2.json b/src/data/cloudhsmv2/2017-04-28/api-2.json index 6e3ed4dbcb..41f63178c9 100644 --- a/src/data/cloudhsmv2/2017-04-28/api-2.json +++ b/src/data/cloudhsmv2/2017-04-28/api-2.json @@ -12,7 +12,8 @@ "signatureVersion":"v4", "signingName":"cloudhsm", "targetPrefix":"BaldrApiService", - "uid":"cloudhsmv2-2017-04-28" + "uid":"cloudhsmv2-2017-04-28", + "auth":["aws.auth#sigv4"] }, "operations":{ "CopyBackupToRegion":{ @@ -114,6 +115,22 @@ {"shape":"CloudHsmAccessDeniedException"} ] }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "output":{"shape":"DeleteResourcePolicyResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmAccessDeniedException"} + ] + }, "DescribeBackups":{ "name":"DescribeBackups", "http":{ @@ -147,6 +164,22 @@ {"shape":"CloudHsmTagException"} ] }, + "GetResourcePolicy":{ + "name":"GetResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourcePolicyRequest"}, + "output":{"shape":"GetResourcePolicyResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmAccessDeniedException"} + ] + }, "InitializeCluster":{ "name":"InitializeCluster", "http":{ @@ -212,6 +245,22 @@ {"shape":"CloudHsmServiceException"} ] }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmAccessDeniedException"} + ] + }, "RestoreBackup":{ "name":"RestoreBackup", "http":{ @@ -269,6 +318,7 @@ "required":["BackupId"], "members":{ "BackupId":{"shape":"BackupId"}, + "BackupArn":{"shape":"BackupArn"}, "BackupState":{"shape":"BackupState"}, "ClusterId":{"shape":"ClusterId"}, "CreateTimestamp":{"shape":"Timestamp"}, @@ -283,6 +333,10 @@ "Mode":{"shape":"ClusterMode"} } }, + "BackupArn":{ + "type":"string", + "pattern":"^(arn:aws(-(us-gov))?:cloudhsm:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]{1}):[0-9]{12}:backup/)?backup-[2-7a-zA-Z]{11,16}" + }, "BackupId":{ "type":"string", "pattern":"backup-[2-7a-zA-Z]{11,16}" @@ -349,6 +403,10 @@ }, "exception":true }, + "CloudHsmArn":{ + "type":"string", + "pattern":"arn:aws(-(us-gov))?:cloudhsm:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]{1}):[0-9]{12}:(backup/backup|cluster/cluster|hsm/hsm)-[2-7a-zA-Z]{11,16}" + }, "CloudHsmInternalFailureException":{ "type":"structure", "members":{ @@ -467,7 +525,7 @@ "members":{ "BackupRetentionPolicy":{"shape":"BackupRetentionPolicy"}, "HsmType":{"shape":"HsmType"}, - "SourceBackupId":{"shape":"BackupId"}, + "SourceBackupId":{"shape":"BackupArn"}, "SubnetIds":{"shape":"SubnetIds"}, "TagList":{"shape":"TagList"}, "Mode":{"shape":"ClusterMode"} @@ -539,12 +597,26 @@ "HsmId":{"shape":"HsmId"} } }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "members":{ + "ResourceArn":{"shape":"CloudHsmArn"} + } + }, + "DeleteResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ResourceArn":{"shape":"CloudHsmArn"}, + "Policy":{"shape":"ResourcePolicy"} + } + }, "DescribeBackupsRequest":{ "type":"structure", "members":{ "NextToken":{"shape":"NextToken"}, "MaxResults":{"shape":"BackupsMaxSize"}, "Filters":{"shape":"Filters"}, + "Shared":{"shape":"Boolean"}, "SortAscending":{"shape":"Boolean"} } }, @@ -602,6 +674,18 @@ "value":{"shape":"Strings"}, "max":30 }, + "GetResourcePolicyRequest":{ + "type":"structure", + "members":{ + "ResourceArn":{"shape":"CloudHsmArn"} + } + }, + "GetResourcePolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{"shape":"ResourcePolicy"} + } + }, "Hsm":{ "type":"structure", "required":["HsmId"], @@ -729,6 +813,20 @@ "max":32, "min":7 }, + "PutResourcePolicyRequest":{ + "type":"structure", + "members":{ + "ResourceArn":{"shape":"CloudHsmArn"}, + "Policy":{"shape":"ResourcePolicy"} + } + }, + "PutResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ResourceArn":{"shape":"CloudHsmArn"}, + "Policy":{"shape":"ResourcePolicy"} + } + }, "Region":{ "type":"string", "pattern":"[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d" @@ -737,6 +835,11 @@ "type":"string", "pattern":"(?:cluster|backup)-[2-7a-zA-Z]{11,16}" }, + "ResourcePolicy":{ + "type":"string", + "max":20000, + "min":1 + }, "RestoreBackupRequest":{ "type":"structure", "required":["BackupId"], diff --git a/src/data/cloudhsmv2/2017-04-28/api-2.json.php b/src/data/cloudhsmv2/2017-04-28/api-2.json.php index d10f67727e..c3d569e92a 100644 --- a/src/data/cloudhsmv2/2017-04-28/api-2.json.php +++ b/src/data/cloudhsmv2/2017-04-28/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2017-04-28', 'endpointPrefix' => 'cloudhsmv2', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'CloudHSM V2', 'serviceFullName' => 'AWS CloudHSM V2', 'serviceId' => 'CloudHSM V2', 'signatureVersion' => 'v4', 'signingName' => 'cloudhsm', 'targetPrefix' => 'BaldrApiService', 'uid' => 'cloudhsmv2-2017-04-28', ], 'operations' => [ 'CopyBackupToRegion' => [ 'name' => 'CopyBackupToRegion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyBackupToRegionRequest', ], 'output' => [ 'shape' => 'CopyBackupToRegionResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'CreateHsm' => [ 'name' => 'CreateHsm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHsmRequest', ], 'output' => [ 'shape' => 'CreateHsmResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmAccessDeniedException', ], ], ], 'DeleteBackup' => [ 'name' => 'DeleteBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBackupRequest', ], 'output' => [ 'shape' => 'DeleteBackupResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'DeleteHsm' => [ 'name' => 'DeleteHsm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHsmRequest', ], 'output' => [ 'shape' => 'DeleteHsmResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmAccessDeniedException', ], ], ], 'DescribeBackups' => [ 'name' => 'DescribeBackups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBackupsRequest', ], 'output' => [ 'shape' => 'DescribeBackupsResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'DescribeClusters' => [ 'name' => 'DescribeClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClustersRequest', ], 'output' => [ 'shape' => 'DescribeClustersResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'InitializeCluster' => [ 'name' => 'InitializeCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'InitializeClusterRequest', ], 'output' => [ 'shape' => 'InitializeClusterResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'ModifyBackupAttributes' => [ 'name' => 'ModifyBackupAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyBackupAttributesRequest', ], 'output' => [ 'shape' => 'ModifyBackupAttributesResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'ModifyCluster' => [ 'name' => 'ModifyCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyClusterRequest', ], 'output' => [ 'shape' => 'ModifyClusterResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'RestoreBackup' => [ 'name' => 'RestoreBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreBackupRequest', ], 'output' => [ 'shape' => 'RestoreBackupResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], ], 'shapes' => [ 'Backup' => [ 'type' => 'structure', 'required' => [ 'BackupId', ], 'members' => [ 'BackupId' => [ 'shape' => 'BackupId', ], 'BackupState' => [ 'shape' => 'BackupState', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], 'CopyTimestamp' => [ 'shape' => 'Timestamp', ], 'NeverExpires' => [ 'shape' => 'Boolean', ], 'SourceRegion' => [ 'shape' => 'Region', ], 'SourceBackup' => [ 'shape' => 'BackupId', ], 'SourceCluster' => [ 'shape' => 'ClusterId', ], 'DeleteTimestamp' => [ 'shape' => 'Timestamp', ], 'TagList' => [ 'shape' => 'TagList', ], 'HsmType' => [ 'shape' => 'HsmType', ], 'Mode' => [ 'shape' => 'ClusterMode', ], ], ], 'BackupId' => [ 'type' => 'string', 'pattern' => 'backup-[2-7a-zA-Z]{11,16}', ], 'BackupPolicy' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', ], ], 'BackupRetentionPolicy' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'BackupRetentionType', ], 'Value' => [ 'shape' => 'BackupRetentionValue', ], ], ], 'BackupRetentionType' => [ 'type' => 'string', 'enum' => [ 'DAYS', ], ], 'BackupRetentionValue' => [ 'type' => 'string', 'max' => 3, 'min' => 1, 'pattern' => '[0-9]+', ], 'BackupState' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'READY', 'DELETED', 'PENDING_DELETION', ], ], 'Backups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Backup', ], ], 'BackupsMaxSize' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'Boolean' => [ 'type' => 'boolean', ], 'Cert' => [ 'type' => 'string', 'max' => 20000, 'pattern' => '[a-zA-Z0-9+-/=\\s]*', ], 'Certificates' => [ 'type' => 'structure', 'members' => [ 'ClusterCsr' => [ 'shape' => 'Cert', ], 'HsmCertificate' => [ 'shape' => 'Cert', ], 'AwsHardwareCertificate' => [ 'shape' => 'Cert', ], 'ManufacturerHardwareCertificate' => [ 'shape' => 'Cert', ], 'ClusterCertificate' => [ 'shape' => 'Cert', ], ], ], 'CloudHsmAccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'CloudHsmInternalFailureException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, 'fault' => true, ], 'CloudHsmInvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'CloudHsmResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'CloudHsmServiceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'CloudHsmTagException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'Cluster' => [ 'type' => 'structure', 'members' => [ 'BackupPolicy' => [ 'shape' => 'BackupPolicy', ], 'BackupRetentionPolicy' => [ 'shape' => 'BackupRetentionPolicy', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], 'Hsms' => [ 'shape' => 'Hsms', ], 'HsmType' => [ 'shape' => 'HsmType', ], 'PreCoPassword' => [ 'shape' => 'PreCoPassword', ], 'SecurityGroup' => [ 'shape' => 'SecurityGroup', ], 'SourceBackupId' => [ 'shape' => 'BackupId', ], 'State' => [ 'shape' => 'ClusterState', ], 'StateMessage' => [ 'shape' => 'StateMessage', ], 'SubnetMapping' => [ 'shape' => 'ExternalSubnetMapping', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'Certificates' => [ 'shape' => 'Certificates', ], 'TagList' => [ 'shape' => 'TagList', ], 'Mode' => [ 'shape' => 'ClusterMode', ], ], ], 'ClusterId' => [ 'type' => 'string', 'pattern' => 'cluster-[2-7a-zA-Z]{11,16}', ], 'ClusterMode' => [ 'type' => 'string', 'enum' => [ 'FIPS', 'NON_FIPS', ], ], 'ClusterState' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'UNINITIALIZED', 'INITIALIZE_IN_PROGRESS', 'INITIALIZED', 'ACTIVE', 'UPDATE_IN_PROGRESS', 'DELETE_IN_PROGRESS', 'DELETED', 'DEGRADED', ], ], 'Clusters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cluster', ], ], 'ClustersMaxSize' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'CopyBackupToRegionRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationRegion', 'BackupId', ], 'members' => [ 'DestinationRegion' => [ 'shape' => 'Region', ], 'BackupId' => [ 'shape' => 'BackupId', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'CopyBackupToRegionResponse' => [ 'type' => 'structure', 'members' => [ 'DestinationBackup' => [ 'shape' => 'DestinationBackup', ], ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'HsmType', 'SubnetIds', ], 'members' => [ 'BackupRetentionPolicy' => [ 'shape' => 'BackupRetentionPolicy', ], 'HsmType' => [ 'shape' => 'HsmType', ], 'SourceBackupId' => [ 'shape' => 'BackupId', ], 'SubnetIds' => [ 'shape' => 'SubnetIds', ], 'TagList' => [ 'shape' => 'TagList', ], 'Mode' => [ 'shape' => 'ClusterMode', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'Cluster' => [ 'shape' => 'Cluster', ], ], ], 'CreateHsmRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'AvailabilityZone', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'AvailabilityZone' => [ 'shape' => 'ExternalAz', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], ], ], 'CreateHsmResponse' => [ 'type' => 'structure', 'members' => [ 'Hsm' => [ 'shape' => 'Hsm', ], ], ], 'DeleteBackupRequest' => [ 'type' => 'structure', 'required' => [ 'BackupId', ], 'members' => [ 'BackupId' => [ 'shape' => 'BackupId', ], ], ], 'DeleteBackupResponse' => [ 'type' => 'structure', 'members' => [ 'Backup' => [ 'shape' => 'Backup', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'members' => [ 'Cluster' => [ 'shape' => 'Cluster', ], ], ], 'DeleteHsmRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'HsmId' => [ 'shape' => 'HsmId', ], 'EniId' => [ 'shape' => 'EniId', ], 'EniIp' => [ 'shape' => 'IpAddress', ], ], ], 'DeleteHsmResponse' => [ 'type' => 'structure', 'members' => [ 'HsmId' => [ 'shape' => 'HsmId', ], ], ], 'DescribeBackupsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'BackupsMaxSize', ], 'Filters' => [ 'shape' => 'Filters', ], 'SortAscending' => [ 'shape' => 'Boolean', ], ], ], 'DescribeBackupsResponse' => [ 'type' => 'structure', 'members' => [ 'Backups' => [ 'shape' => 'Backups', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeClustersRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'Filters', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ClustersMaxSize', ], ], ], 'DescribeClustersResponse' => [ 'type' => 'structure', 'members' => [ 'Clusters' => [ 'shape' => 'Clusters', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DestinationBackup' => [ 'type' => 'structure', 'members' => [ 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], 'SourceRegion' => [ 'shape' => 'Region', ], 'SourceBackup' => [ 'shape' => 'BackupId', ], 'SourceCluster' => [ 'shape' => 'ClusterId', ], ], ], 'EniId' => [ 'type' => 'string', 'pattern' => 'eni-[0-9a-fA-F]{8,17}', ], 'ExternalAz' => [ 'type' => 'string', 'pattern' => '[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d[a-z]', ], 'ExternalSubnetMapping' => [ 'type' => 'map', 'key' => [ 'shape' => 'ExternalAz', ], 'value' => [ 'shape' => 'SubnetId', ], ], 'Field' => [ 'type' => 'string', 'pattern' => '[a-zA-Z0-9_-]+', ], 'Filters' => [ 'type' => 'map', 'key' => [ 'shape' => 'Field', ], 'value' => [ 'shape' => 'Strings', ], 'max' => 30, ], 'Hsm' => [ 'type' => 'structure', 'required' => [ 'HsmId', ], 'members' => [ 'AvailabilityZone' => [ 'shape' => 'ExternalAz', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'EniId' => [ 'shape' => 'EniId', ], 'EniIp' => [ 'shape' => 'IpAddress', ], 'HsmId' => [ 'shape' => 'HsmId', ], 'State' => [ 'shape' => 'HsmState', ], 'StateMessage' => [ 'shape' => 'String', ], ], ], 'HsmId' => [ 'type' => 'string', 'pattern' => 'hsm-[2-7a-zA-Z]{11,16}', ], 'HsmState' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'ACTIVE', 'DEGRADED', 'DELETE_IN_PROGRESS', 'DELETED', ], ], 'HsmType' => [ 'type' => 'string', 'max' => 32, 'pattern' => '((p|)hsm[0-9][a-z.]*\\.[a-zA-Z]+)', ], 'Hsms' => [ 'type' => 'list', 'member' => [ 'shape' => 'Hsm', ], ], 'InitializeClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'SignedCert', 'TrustAnchor', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'SignedCert' => [ 'shape' => 'Cert', ], 'TrustAnchor' => [ 'shape' => 'Cert', ], ], ], 'InitializeClusterResponse' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'ClusterState', ], 'StateMessage' => [ 'shape' => 'StateMessage', ], ], ], 'IpAddress' => [ 'type' => 'string', 'pattern' => '\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}', ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxSize', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'required' => [ 'TagList', ], 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'MaxSize' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ModifyBackupAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'BackupId', 'NeverExpires', ], 'members' => [ 'BackupId' => [ 'shape' => 'BackupId', ], 'NeverExpires' => [ 'shape' => 'Boolean', ], ], ], 'ModifyBackupAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'Backup' => [ 'shape' => 'Backup', ], ], ], 'ModifyClusterRequest' => [ 'type' => 'structure', 'required' => [ 'BackupRetentionPolicy', 'ClusterId', ], 'members' => [ 'BackupRetentionPolicy' => [ 'shape' => 'BackupRetentionPolicy', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'ModifyClusterResponse' => [ 'type' => 'structure', 'members' => [ 'Cluster' => [ 'shape' => 'Cluster', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'PreCoPassword' => [ 'type' => 'string', 'max' => 32, 'min' => 7, ], 'Region' => [ 'type' => 'string', 'pattern' => '[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d', ], 'ResourceId' => [ 'type' => 'string', 'pattern' => '(?:cluster|backup)-[2-7a-zA-Z]{11,16}', ], 'RestoreBackupRequest' => [ 'type' => 'structure', 'required' => [ 'BackupId', ], 'members' => [ 'BackupId' => [ 'shape' => 'BackupId', ], ], ], 'RestoreBackupResponse' => [ 'type' => 'structure', 'members' => [ 'Backup' => [ 'shape' => 'Backup', ], ], ], 'SecurityGroup' => [ 'type' => 'string', 'pattern' => 'sg-[0-9a-fA-F]{8,17}', ], 'StateMessage' => [ 'type' => 'string', 'max' => 300, 'pattern' => '.*', ], 'String' => [ 'type' => 'string', ], 'Strings' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'SubnetId' => [ 'type' => 'string', 'pattern' => 'subnet-[0-9a-fA-F]{8,17}', ], 'SubnetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 10, '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' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagList', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagKeyList', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagKeyList' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'VpcId' => [ 'type' => 'string', 'pattern' => 'vpc-[0-9a-fA-F]', ], 'errorMessage' => [ 'type' => 'string', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2017-04-28', 'endpointPrefix' => 'cloudhsmv2', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'CloudHSM V2', 'serviceFullName' => 'AWS CloudHSM V2', 'serviceId' => 'CloudHSM V2', 'signatureVersion' => 'v4', 'signingName' => 'cloudhsm', 'targetPrefix' => 'BaldrApiService', 'uid' => 'cloudhsmv2-2017-04-28', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'CopyBackupToRegion' => [ 'name' => 'CopyBackupToRegion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyBackupToRegionRequest', ], 'output' => [ 'shape' => 'CopyBackupToRegionResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'CreateCluster' => [ 'name' => 'CreateCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateClusterRequest', ], 'output' => [ 'shape' => 'CreateClusterResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'CreateHsm' => [ 'name' => 'CreateHsm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateHsmRequest', ], 'output' => [ 'shape' => 'CreateHsmResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmAccessDeniedException', ], ], ], 'DeleteBackup' => [ 'name' => 'DeleteBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBackupRequest', ], 'output' => [ 'shape' => 'DeleteBackupResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'DeleteCluster' => [ 'name' => 'DeleteCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteClusterRequest', ], 'output' => [ 'shape' => 'DeleteClusterResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'DeleteHsm' => [ 'name' => 'DeleteHsm', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteHsmRequest', ], 'output' => [ 'shape' => 'DeleteHsmResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmAccessDeniedException', ], ], ], 'DeleteResourcePolicy' => [ 'name' => 'DeleteResourcePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourcePolicyRequest', ], 'output' => [ 'shape' => 'DeleteResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmAccessDeniedException', ], ], ], 'DescribeBackups' => [ 'name' => 'DescribeBackups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeBackupsRequest', ], 'output' => [ 'shape' => 'DescribeBackupsResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'DescribeClusters' => [ 'name' => 'DescribeClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClustersRequest', ], 'output' => [ 'shape' => 'DescribeClustersResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'GetResourcePolicy' => [ 'name' => 'GetResourcePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetResourcePolicyRequest', ], 'output' => [ 'shape' => 'GetResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmAccessDeniedException', ], ], ], 'InitializeCluster' => [ 'name' => 'InitializeCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'InitializeClusterRequest', ], 'output' => [ 'shape' => 'InitializeClusterResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'ListTags' => [ 'name' => 'ListTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsRequest', ], 'output' => [ 'shape' => 'ListTagsResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'ModifyBackupAttributes' => [ 'name' => 'ModifyBackupAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyBackupAttributesRequest', ], 'output' => [ 'shape' => 'ModifyBackupAttributesResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'ModifyCluster' => [ 'name' => 'ModifyCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyClusterRequest', ], 'output' => [ 'shape' => 'ModifyClusterResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'PutResourcePolicy' => [ 'name' => 'PutResourcePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutResourcePolicyRequest', ], 'output' => [ 'shape' => 'PutResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmAccessDeniedException', ], ], ], 'RestoreBackup' => [ 'name' => 'RestoreBackup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RestoreBackupRequest', ], 'output' => [ 'shape' => 'RestoreBackupResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'CloudHsmAccessDeniedException', ], [ 'shape' => 'CloudHsmInternalFailureException', ], [ 'shape' => 'CloudHsmInvalidRequestException', ], [ 'shape' => 'CloudHsmResourceNotFoundException', ], [ 'shape' => 'CloudHsmServiceException', ], [ 'shape' => 'CloudHsmTagException', ], ], ], ], 'shapes' => [ 'Backup' => [ 'type' => 'structure', 'required' => [ 'BackupId', ], 'members' => [ 'BackupId' => [ 'shape' => 'BackupId', ], 'BackupArn' => [ 'shape' => 'BackupArn', ], 'BackupState' => [ 'shape' => 'BackupState', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], 'CopyTimestamp' => [ 'shape' => 'Timestamp', ], 'NeverExpires' => [ 'shape' => 'Boolean', ], 'SourceRegion' => [ 'shape' => 'Region', ], 'SourceBackup' => [ 'shape' => 'BackupId', ], 'SourceCluster' => [ 'shape' => 'ClusterId', ], 'DeleteTimestamp' => [ 'shape' => 'Timestamp', ], 'TagList' => [ 'shape' => 'TagList', ], 'HsmType' => [ 'shape' => 'HsmType', ], 'Mode' => [ 'shape' => 'ClusterMode', ], ], ], 'BackupArn' => [ 'type' => 'string', 'pattern' => '^(arn:aws(-(us-gov))?:cloudhsm:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]{1}):[0-9]{12}:backup/)?backup-[2-7a-zA-Z]{11,16}', ], 'BackupId' => [ 'type' => 'string', 'pattern' => 'backup-[2-7a-zA-Z]{11,16}', ], 'BackupPolicy' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', ], ], 'BackupRetentionPolicy' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'BackupRetentionType', ], 'Value' => [ 'shape' => 'BackupRetentionValue', ], ], ], 'BackupRetentionType' => [ 'type' => 'string', 'enum' => [ 'DAYS', ], ], 'BackupRetentionValue' => [ 'type' => 'string', 'max' => 3, 'min' => 1, 'pattern' => '[0-9]+', ], 'BackupState' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'READY', 'DELETED', 'PENDING_DELETION', ], ], 'Backups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Backup', ], ], 'BackupsMaxSize' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'Boolean' => [ 'type' => 'boolean', ], 'Cert' => [ 'type' => 'string', 'max' => 20000, 'pattern' => '[a-zA-Z0-9+-/=\\s]*', ], 'Certificates' => [ 'type' => 'structure', 'members' => [ 'ClusterCsr' => [ 'shape' => 'Cert', ], 'HsmCertificate' => [ 'shape' => 'Cert', ], 'AwsHardwareCertificate' => [ 'shape' => 'Cert', ], 'ManufacturerHardwareCertificate' => [ 'shape' => 'Cert', ], 'ClusterCertificate' => [ 'shape' => 'Cert', ], ], ], 'CloudHsmAccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'CloudHsmArn' => [ 'type' => 'string', 'pattern' => 'arn:aws(-(us-gov))?:cloudhsm:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]{1}):[0-9]{12}:(backup/backup|cluster/cluster|hsm/hsm)-[2-7a-zA-Z]{11,16}', ], 'CloudHsmInternalFailureException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, 'fault' => true, ], 'CloudHsmInvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'CloudHsmResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'CloudHsmServiceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'CloudHsmTagException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'errorMessage', ], ], 'exception' => true, ], 'Cluster' => [ 'type' => 'structure', 'members' => [ 'BackupPolicy' => [ 'shape' => 'BackupPolicy', ], 'BackupRetentionPolicy' => [ 'shape' => 'BackupRetentionPolicy', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], 'Hsms' => [ 'shape' => 'Hsms', ], 'HsmType' => [ 'shape' => 'HsmType', ], 'PreCoPassword' => [ 'shape' => 'PreCoPassword', ], 'SecurityGroup' => [ 'shape' => 'SecurityGroup', ], 'SourceBackupId' => [ 'shape' => 'BackupId', ], 'State' => [ 'shape' => 'ClusterState', ], 'StateMessage' => [ 'shape' => 'StateMessage', ], 'SubnetMapping' => [ 'shape' => 'ExternalSubnetMapping', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'Certificates' => [ 'shape' => 'Certificates', ], 'TagList' => [ 'shape' => 'TagList', ], 'Mode' => [ 'shape' => 'ClusterMode', ], ], ], 'ClusterId' => [ 'type' => 'string', 'pattern' => 'cluster-[2-7a-zA-Z]{11,16}', ], 'ClusterMode' => [ 'type' => 'string', 'enum' => [ 'FIPS', 'NON_FIPS', ], ], 'ClusterState' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'UNINITIALIZED', 'INITIALIZE_IN_PROGRESS', 'INITIALIZED', 'ACTIVE', 'UPDATE_IN_PROGRESS', 'DELETE_IN_PROGRESS', 'DELETED', 'DEGRADED', ], ], 'Clusters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Cluster', ], ], 'ClustersMaxSize' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'CopyBackupToRegionRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationRegion', 'BackupId', ], 'members' => [ 'DestinationRegion' => [ 'shape' => 'Region', ], 'BackupId' => [ 'shape' => 'BackupId', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'CopyBackupToRegionResponse' => [ 'type' => 'structure', 'members' => [ 'DestinationBackup' => [ 'shape' => 'DestinationBackup', ], ], ], 'CreateClusterRequest' => [ 'type' => 'structure', 'required' => [ 'HsmType', 'SubnetIds', ], 'members' => [ 'BackupRetentionPolicy' => [ 'shape' => 'BackupRetentionPolicy', ], 'HsmType' => [ 'shape' => 'HsmType', ], 'SourceBackupId' => [ 'shape' => 'BackupArn', ], 'SubnetIds' => [ 'shape' => 'SubnetIds', ], 'TagList' => [ 'shape' => 'TagList', ], 'Mode' => [ 'shape' => 'ClusterMode', ], ], ], 'CreateClusterResponse' => [ 'type' => 'structure', 'members' => [ 'Cluster' => [ 'shape' => 'Cluster', ], ], ], 'CreateHsmRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'AvailabilityZone', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'AvailabilityZone' => [ 'shape' => 'ExternalAz', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], ], ], 'CreateHsmResponse' => [ 'type' => 'structure', 'members' => [ 'Hsm' => [ 'shape' => 'Hsm', ], ], ], 'DeleteBackupRequest' => [ 'type' => 'structure', 'required' => [ 'BackupId', ], 'members' => [ 'BackupId' => [ 'shape' => 'BackupId', ], ], ], 'DeleteBackupResponse' => [ 'type' => 'structure', 'members' => [ 'Backup' => [ 'shape' => 'Backup', ], ], ], 'DeleteClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'DeleteClusterResponse' => [ 'type' => 'structure', 'members' => [ 'Cluster' => [ 'shape' => 'Cluster', ], ], ], 'DeleteHsmRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'HsmId' => [ 'shape' => 'HsmId', ], 'EniId' => [ 'shape' => 'EniId', ], 'EniIp' => [ 'shape' => 'IpAddress', ], ], ], 'DeleteHsmResponse' => [ 'type' => 'structure', 'members' => [ 'HsmId' => [ 'shape' => 'HsmId', ], ], ], 'DeleteResourcePolicyRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'CloudHsmArn', ], ], ], 'DeleteResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'CloudHsmArn', ], 'Policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'DescribeBackupsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'BackupsMaxSize', ], 'Filters' => [ 'shape' => 'Filters', ], 'Shared' => [ 'shape' => 'Boolean', ], 'SortAscending' => [ 'shape' => 'Boolean', ], ], ], 'DescribeBackupsResponse' => [ 'type' => 'structure', 'members' => [ 'Backups' => [ 'shape' => 'Backups', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeClustersRequest' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'Filters', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'ClustersMaxSize', ], ], ], 'DescribeClustersResponse' => [ 'type' => 'structure', 'members' => [ 'Clusters' => [ 'shape' => 'Clusters', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'DestinationBackup' => [ 'type' => 'structure', 'members' => [ 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], 'SourceRegion' => [ 'shape' => 'Region', ], 'SourceBackup' => [ 'shape' => 'BackupId', ], 'SourceCluster' => [ 'shape' => 'ClusterId', ], ], ], 'EniId' => [ 'type' => 'string', 'pattern' => 'eni-[0-9a-fA-F]{8,17}', ], 'ExternalAz' => [ 'type' => 'string', 'pattern' => '[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d[a-z]', ], 'ExternalSubnetMapping' => [ 'type' => 'map', 'key' => [ 'shape' => 'ExternalAz', ], 'value' => [ 'shape' => 'SubnetId', ], ], 'Field' => [ 'type' => 'string', 'pattern' => '[a-zA-Z0-9_-]+', ], 'Filters' => [ 'type' => 'map', 'key' => [ 'shape' => 'Field', ], 'value' => [ 'shape' => 'Strings', ], 'max' => 30, ], 'GetResourcePolicyRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'CloudHsmArn', ], ], ], 'GetResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'Hsm' => [ 'type' => 'structure', 'required' => [ 'HsmId', ], 'members' => [ 'AvailabilityZone' => [ 'shape' => 'ExternalAz', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], 'SubnetId' => [ 'shape' => 'SubnetId', ], 'EniId' => [ 'shape' => 'EniId', ], 'EniIp' => [ 'shape' => 'IpAddress', ], 'HsmId' => [ 'shape' => 'HsmId', ], 'State' => [ 'shape' => 'HsmState', ], 'StateMessage' => [ 'shape' => 'String', ], ], ], 'HsmId' => [ 'type' => 'string', 'pattern' => 'hsm-[2-7a-zA-Z]{11,16}', ], 'HsmState' => [ 'type' => 'string', 'enum' => [ 'CREATE_IN_PROGRESS', 'ACTIVE', 'DEGRADED', 'DELETE_IN_PROGRESS', 'DELETED', ], ], 'HsmType' => [ 'type' => 'string', 'max' => 32, 'pattern' => '((p|)hsm[0-9][a-z.]*\\.[a-zA-Z]+)', ], 'Hsms' => [ 'type' => 'list', 'member' => [ 'shape' => 'Hsm', ], ], 'InitializeClusterRequest' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'SignedCert', 'TrustAnchor', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'SignedCert' => [ 'shape' => 'Cert', ], 'TrustAnchor' => [ 'shape' => 'Cert', ], ], ], 'InitializeClusterResponse' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'ClusterState', ], 'StateMessage' => [ 'shape' => 'StateMessage', ], ], ], 'IpAddress' => [ 'type' => 'string', 'pattern' => '\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}', ], 'ListTagsRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxSize', ], ], ], 'ListTagsResponse' => [ 'type' => 'structure', 'required' => [ 'TagList', ], 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'MaxSize' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'ModifyBackupAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'BackupId', 'NeverExpires', ], 'members' => [ 'BackupId' => [ 'shape' => 'BackupId', ], 'NeverExpires' => [ 'shape' => 'Boolean', ], ], ], 'ModifyBackupAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'Backup' => [ 'shape' => 'Backup', ], ], ], 'ModifyClusterRequest' => [ 'type' => 'structure', 'required' => [ 'BackupRetentionPolicy', 'ClusterId', ], 'members' => [ 'BackupRetentionPolicy' => [ 'shape' => 'BackupRetentionPolicy', ], 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'ModifyClusterResponse' => [ 'type' => 'structure', 'members' => [ 'Cluster' => [ 'shape' => 'Cluster', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 256, 'pattern' => '.*', ], 'PreCoPassword' => [ 'type' => 'string', 'max' => 32, 'min' => 7, ], 'PutResourcePolicyRequest' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'CloudHsmArn', ], 'Policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'PutResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'CloudHsmArn', ], 'Policy' => [ 'shape' => 'ResourcePolicy', ], ], ], 'Region' => [ 'type' => 'string', 'pattern' => '[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d', ], 'ResourceId' => [ 'type' => 'string', 'pattern' => '(?:cluster|backup)-[2-7a-zA-Z]{11,16}', ], 'ResourcePolicy' => [ 'type' => 'string', 'max' => 20000, 'min' => 1, ], 'RestoreBackupRequest' => [ 'type' => 'structure', 'required' => [ 'BackupId', ], 'members' => [ 'BackupId' => [ 'shape' => 'BackupId', ], ], ], 'RestoreBackupResponse' => [ 'type' => 'structure', 'members' => [ 'Backup' => [ 'shape' => 'Backup', ], ], ], 'SecurityGroup' => [ 'type' => 'string', 'pattern' => 'sg-[0-9a-fA-F]{8,17}', ], 'StateMessage' => [ 'type' => 'string', 'max' => 300, 'pattern' => '.*', ], 'String' => [ 'type' => 'string', ], 'Strings' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'SubnetId' => [ 'type' => 'string', 'pattern' => 'subnet-[0-9a-fA-F]{8,17}', ], 'SubnetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 10, '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' => 50, 'min' => 1, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagList', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagKeyList', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagKeyList' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'VpcId' => [ 'type' => 'string', 'pattern' => 'vpc-[0-9a-fA-F]', ], 'errorMessage' => [ 'type' => 'string', ], ],]; diff --git a/src/data/cloudhsmv2/2017-04-28/docs-2.json b/src/data/cloudhsmv2/2017-04-28/docs-2.json index 4c60d0e965..e4b2ef40bf 100644 --- a/src/data/cloudhsmv2/2017-04-28/docs-2.json +++ b/src/data/cloudhsmv2/2017-04-28/docs-2.json @@ -1,26 +1,29 @@ { "version": "2.0", - "service": "
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
", + "service": "For more information about CloudHSM, see CloudHSM and the CloudHSM User Guide.
", "operations": { - "CopyBackupToRegion": "Copy an AWS CloudHSM cluster backup to a different region.
", - "CreateCluster": "Creates a new AWS CloudHSM cluster.
", - "CreateHsm": "Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
", - "DeleteBackup": "Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
", - "DeleteCluster": "Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
", - "DeleteHsm": "Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
", - "DescribeBackups": "Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken
value. Use this value in a subsequent DescribeBackups
request to get more backups. When you receive a response with no NextToken
(or an empty or null value), that means there are no more backups to get.
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken
value. Use this value in a subsequent DescribeClusters
request to get more clusters. When you receive a response with no NextToken
(or an empty or null value), that means there are no more clusters to get.
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
", - "ListTags": "Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken
value. Use this value in a subsequent ListTags
request to get more tags. When you receive a response with no NextToken
(or an empty or null value), that means there are no more tags to get.
Modifies attributes for AWS CloudHSM backup.
", - "ModifyCluster": "Modifies AWS CloudHSM cluster.
", - "RestoreBackup": "Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION
state. For mor information on deleting a backup, see DeleteBackup.
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
", - "UntagResource": "Removes the specified tag or tags from the specified AWS CloudHSM cluster.
" + "CopyBackupToRegion": "Copy an CloudHSM cluster backup to a different region.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
", + "CreateCluster": "Creates a new CloudHSM cluster.
Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.
", + "CreateHsm": "Creates a new hardware security module (HSM) in the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.
", + "DeleteBackup": "Deletes a specified CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
", + "DeleteCluster": "Deletes the specified CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
", + "DeleteHsm": "Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.
", + "DeleteResourcePolicy": "Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
", + "DescribeBackups": "Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken
value. Use this value in a subsequent DescribeBackups
request to get more backups. When you receive a response with no NextToken
(or an empty or null value), that means there are no more backups to get.
Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.
", + "DescribeClusters": "Gets information about CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken
value. Use this value in a subsequent DescribeClusters
request to get more clusters. When you receive a response with no NextToken
(or an empty or null value), that means there are no more clusters to get.
Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.
", + "GetResourcePolicy": "Retrieves the resource policy document attached to a given resource.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
", + "InitializeCluster": "Claims an CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
", + "ListTags": "Gets a list of tags for the specified CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken
value. Use this value in a subsequent ListTags
request to get more tags. When you receive a response with no NextToken
(or an empty or null value), that means there are no more tags to get.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
", + "ModifyBackupAttributes": "Modifies attributes for CloudHSM backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
", + "ModifyCluster": "Modifies CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
", + "PutResourcePolicy": "Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies:
Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.
In order to share a backup, it must be in a 'READY' state and you must own it.
While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to describe the backups you share with them, you must promote the backup to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information, see Working with shared backups in the CloudHSM User Guide
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
", + "RestoreBackup": "Restores a specified CloudHSM backup that is in the PENDING_DELETION
state. For more information on deleting a backup, see DeleteBackup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
", + "TagResource": "Adds or overwrites one or more tags for the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
", + "UntagResource": "Removes the specified tag or tags from the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" }, "shapes": { "Backup": { - "base": "Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId
, BackupState
, ClusterId
, and CreateTimestamp
parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp
, SourceBackup
, SourceCluster
, and SourceRegion
parameters. A backup that is pending deletion will include the DeleteTimestamp
parameter.
Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId
, BackupState
, ClusterId
, and CreateTimestamp
parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp
, SourceBackup
, SourceCluster
, and SourceRegion
parameters. A backup that is pending deletion will include the DeleteTimestamp
parameter.
Information on the Backup
object deleted.
Information on the Backup
object created.
The Amazon Resource Name (ARN) of the backup.
", + "CreateClusterRequest$SourceBackupId": "The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.
" + } + }, "BackupId": { "base": null, "refs": { @@ -35,7 +45,6 @@ "Backup$SourceBackup": "The identifier (ID) of the source backup from which the new backup was copied.
", "Cluster$SourceBackupId": "The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
", "CopyBackupToRegionRequest$BackupId": "The ID of the backup that will be copied to the destination region.
", - "CreateClusterRequest$SourceBackupId": "The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.
", "DeleteBackupRequest$BackupId": "The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
", "DestinationBackup$SourceBackup": "The identifier (ID) of the source backup from which the new backup was copied.
", "ModifyBackupAttributesRequest$BackupId": "The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.
", @@ -90,6 +99,7 @@ "base": null, "refs": { "Backup$NeverExpires": "Specifies whether the service should exempt a backup from the retention policy for the cluster. True
exempts a backup from the retention policy. False
means the service applies the backup retention policy defined at the cluster.
Describe backups that are shared with you.
By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.
Designates whether or not to sort the return backups by ascending chronological order of generation.
", "ModifyBackupAttributesRequest$NeverExpires": "Specifies whether the service should exempt a backup from the retention policy for the cluster. True
exempts a backup from the retention policy. False
means the service applies the backup retention policy defined at the cluster.
The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED
.
The HSM certificate issued (signed) by the HSM hardware.
", - "Certificates$AwsHardwareCertificate": "The HSM hardware certificate issued (signed) by AWS CloudHSM.
", + "Certificates$AwsHardwareCertificate": "The HSM hardware certificate issued (signed) by CloudHSM.
", "Certificates$ManufacturerHardwareCertificate": "The HSM hardware certificate issued (signed) by the hardware manufacturer.
", "Certificates$ClusterCertificate": "The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
", "InitializeClusterRequest$SignedCert": "The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.
", @@ -117,8 +127,18 @@ "refs": { } }, + "CloudHsmArn": { + "base": null, + "refs": { + "DeleteResourcePolicyRequest$ResourceArn": "Amazon Resource Name (ARN) of the resource from which the policy will be removed.
", + "DeleteResourcePolicyResponse$ResourceArn": "Amazon Resource Name (ARN) of the resource from which the policy was deleted.
", + "GetResourcePolicyRequest$ResourceArn": "Amazon Resource Name (ARN) of the resource to which a policy is attached.
", + "PutResourcePolicyRequest$ResourceArn": "Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
", + "PutResourcePolicyResponse$ResourceArn": "Amazon Resource Name (ARN) of the resource to which a policy is attached.
" + } + }, "CloudHsmInternalFailureException": { - "base": "The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
", + "base": "The request was rejected because of an CloudHSM internal failure. The request can be retried.
", "refs": { } }, @@ -143,7 +163,7 @@ } }, "Cluster": { - "base": "Contains information about an AWS CloudHSM cluster.
", + "base": "Contains information about an CloudHSM cluster.
", "refs": { "Clusters$member": null, "CreateClusterResponse$Cluster": "Information about the cluster that was created.
", @@ -253,6 +273,16 @@ "refs": { } }, + "DeleteResourcePolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteResourcePolicyResponse": { + "base": null, + "refs": { + } + }, "DescribeBackupsRequest": { "base": null, "refs": { @@ -313,8 +343,18 @@ "DescribeClustersRequest$Filters": "One or more filters to limit the items returned in the response.
Use the clusterIds
filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).
Use the vpcIds
filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).
Use the states
filter to return only clusters that match the specified state.
Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
", + "base": "Contains information about a hardware security module (HSM) in an CloudHSM cluster.
", "refs": { "CreateHsmResponse$Hsm": "Information about the HSM that was created.
", "Hsms$member": null @@ -337,7 +377,7 @@ "HsmType": { "base": null, "refs": { - "Backup$HsmType": "The HSM type of the cluster that was backed up.
", + "Backup$HsmType": "The HSM type used to create the backup.
", "Cluster$HsmType": "The type of HSM that the cluster contains.
", "CreateClusterRequest$HsmType": "The type of HSM to use in the cluster. The allowed values are hsm1.medium
and hsm2m.medium
.
The default password for the cluster's Pre-Crypto Officer (PRECO) user.
" } }, + "PutResourcePolicyRequest": { + "base": null, + "refs": { + } + }, + "PutResourcePolicyResponse": { + "base": null, + "refs": { + } + }, "Region": { "base": null, "refs": { @@ -435,6 +485,15 @@ "UntagResourceRequest$ResourceId": "The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.
" } }, + "ResourcePolicy": { + "base": null, + "refs": { + "DeleteResourcePolicyResponse$Policy": "The policy previously attached to the resource.
", + "GetResourcePolicyResponse$Policy": "The policy attached to a resource.
", + "PutResourcePolicyRequest$Policy": "The policy you want to associate with a resource.
For an example policy, see Working with shared backups in the CloudHSM User Guide
", + "PutResourcePolicyResponse$Policy": "The policy attached to a resource.
" + } + }, "RestoreBackupRequest": { "base": null, "refs": { diff --git a/src/data/cloudhsmv2/2017-04-28/docs-2.json.php b/src/data/cloudhsmv2/2017-04-28/docs-2.json.php index f846affa97..444f4c9312 100644 --- a/src/data/cloudhsmv2/2017-04-28/docs-2.json.php +++ b/src/data/cloudhsmv2/2017-04-28/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
', 'operations' => [ 'CopyBackupToRegion' => 'Copy an AWS CloudHSM cluster backup to a different region.
', 'CreateCluster' => 'Creates a new AWS CloudHSM cluster.
', 'CreateHsm' => 'Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
', 'DeleteBackup' => 'Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
', 'DeleteCluster' => 'Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
', 'DeleteHsm' => 'Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM\'s elastic network interface (ENI), or the ID of the HSM\'s ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
', 'DescribeBackups' => 'Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken
value. Use this value in a subsequent DescribeBackups
request to get more backups. When you receive a response with no NextToken
(or an empty or null value), that means there are no more backups to get.
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken
value. Use this value in a subsequent DescribeClusters
request to get more clusters. When you receive a response with no NextToken
(or an empty or null value), that means there are no more clusters to get.
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA\'s root certificate. Before you can claim a cluster, you must sign the cluster\'s certificate signing request (CSR) with your issuing CA. To get the cluster\'s CSR, use DescribeClusters.
', 'ListTags' => 'Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken
value. Use this value in a subsequent ListTags
request to get more tags. When you receive a response with no NextToken
(or an empty or null value), that means there are no more tags to get.
Modifies attributes for AWS CloudHSM backup.
', 'ModifyCluster' => 'Modifies AWS CloudHSM cluster.
', 'RestoreBackup' => 'Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION
state. For mor information on deleting a backup, see DeleteBackup.
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
', 'UntagResource' => 'Removes the specified tag or tags from the specified AWS CloudHSM cluster.
', ], 'shapes' => [ 'Backup' => [ 'base' => 'Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId
, BackupState
, ClusterId
, and CreateTimestamp
parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp
, SourceBackup
, SourceCluster
, and SourceRegion
parameters. A backup that is pending deletion will include the DeleteTimestamp
parameter.
Information on the Backup
object deleted.
Information on the Backup
object created.
The identifier (ID) of the backup.
', 'Backup$SourceBackup' => 'The identifier (ID) of the source backup from which the new backup was copied.
', 'Cluster$SourceBackupId' => 'The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
', 'CopyBackupToRegionRequest$BackupId' => 'The ID of the backup that will be copied to the destination region.
', 'CreateClusterRequest$SourceBackupId' => 'The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.
', 'DeleteBackupRequest$BackupId' => 'The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
', 'DestinationBackup$SourceBackup' => 'The identifier (ID) of the source backup from which the new backup was copied.
', 'ModifyBackupAttributesRequest$BackupId' => 'The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.
', 'RestoreBackupRequest$BackupId' => 'The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
', ], ], 'BackupPolicy' => [ 'base' => NULL, 'refs' => [ 'Cluster$BackupPolicy' => 'The cluster\'s backup policy.
', ], ], 'BackupRetentionPolicy' => [ 'base' => 'A policy that defines the number of days to retain backups.
', 'refs' => [ 'Cluster$BackupRetentionPolicy' => 'A policy that defines how the service retains backups.
', 'CreateClusterRequest$BackupRetentionPolicy' => 'A policy that defines how the service retains backups.
', 'ModifyClusterRequest$BackupRetentionPolicy' => 'A policy that defines how the service retains backups.
', ], ], 'BackupRetentionType' => [ 'base' => NULL, 'refs' => [ 'BackupRetentionPolicy$Type' => 'The type of backup retention policy. For the DAYS
type, the value is the number of days to retain backups.
Use a value between 7 - 379.
', ], ], 'BackupState' => [ 'base' => NULL, 'refs' => [ 'Backup$BackupState' => 'The state of the backup.
', ], ], 'Backups' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsResponse$Backups' => 'A list of backups.
', ], ], 'BackupsMaxSize' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsRequest$MaxResults' => 'The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken
value.
Specifies whether the service should exempt a backup from the retention policy for the cluster. True
exempts a backup from the retention policy. False
means the service applies the backup retention policy defined at the cluster.
Designates whether or not to sort the return backups by ascending chronological order of generation.
', 'ModifyBackupAttributesRequest$NeverExpires' => 'Specifies whether the service should exempt a backup from the retention policy for the cluster. True
exempts a backup from the retention policy. False
means the service applies the backup retention policy defined at the cluster.
The cluster\'s certificate signing request (CSR). The CSR exists only when the cluster\'s state is UNINITIALIZED
.
The HSM certificate issued (signed) by the HSM hardware.
', 'Certificates$AwsHardwareCertificate' => 'The HSM hardware certificate issued (signed) by AWS CloudHSM.
', 'Certificates$ManufacturerHardwareCertificate' => 'The HSM hardware certificate issued (signed) by the hardware manufacturer.
', 'Certificates$ClusterCertificate' => 'The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster\'s owner.
', 'InitializeClusterRequest$SignedCert' => 'The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.
', 'InitializeClusterRequest$TrustAnchor' => 'The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.
', ], ], 'Certificates' => [ 'base' => 'Contains one or more certificates or a certificate signing request (CSR).
', 'refs' => [ 'Cluster$Certificates' => 'Contains one or more certificates or a certificate signing request (CSR).
', ], ], 'CloudHsmAccessDeniedException' => [ 'base' => 'The request was rejected because the requester does not have permission to perform the requested operation.
', 'refs' => [], ], 'CloudHsmInternalFailureException' => [ 'base' => 'The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
', 'refs' => [], ], 'CloudHsmInvalidRequestException' => [ 'base' => 'The request was rejected because it is not a valid request.
', 'refs' => [], ], 'CloudHsmResourceNotFoundException' => [ 'base' => 'The request was rejected because it refers to a resource that cannot be found.
', 'refs' => [], ], 'CloudHsmServiceException' => [ 'base' => 'The request was rejected because an error occurred.
', 'refs' => [], ], 'CloudHsmTagException' => [ 'base' => 'The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
', 'refs' => [], ], 'Cluster' => [ 'base' => 'Contains information about an AWS CloudHSM cluster.
', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$Cluster' => 'Information about the cluster that was created.
', 'DeleteClusterResponse$Cluster' => 'Information about the cluster that was deleted.
', 'ModifyClusterResponse$Cluster' => NULL, ], ], 'ClusterId' => [ 'base' => NULL, 'refs' => [ 'Backup$ClusterId' => 'The identifier (ID) of the cluster that was backed up.
', 'Backup$SourceCluster' => 'The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
', 'Cluster$ClusterId' => 'The cluster\'s identifier (ID).
', 'CreateHsmRequest$ClusterId' => 'The identifier (ID) of the HSM\'s cluster. To find the cluster ID, use DescribeClusters.
', 'DeleteClusterRequest$ClusterId' => 'The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.
', 'DeleteHsmRequest$ClusterId' => 'The identifier (ID) of the cluster that contains the HSM that you are deleting.
', 'DestinationBackup$SourceCluster' => 'The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
', 'Hsm$ClusterId' => 'The identifier (ID) of the cluster that contains the HSM.
', 'InitializeClusterRequest$ClusterId' => 'The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.
', 'ModifyClusterRequest$ClusterId' => 'The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.
', ], ], 'ClusterMode' => [ 'base' => NULL, 'refs' => [ 'Backup$Mode' => 'The mode of the cluster that was backed up.
', 'Cluster$Mode' => 'The mode of the cluster.
', 'CreateClusterRequest$Mode' => 'The mode to use in the cluster. The allowed values are FIPS
and NON_FIPS
.
The cluster\'s state.
', 'InitializeClusterResponse$State' => 'The cluster\'s state.
', ], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$Clusters' => 'A list of clusters.
', ], ], 'ClustersMaxSize' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$MaxResults' => 'The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken
value.
Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.
', 'refs' => [ 'CopyBackupToRegionResponse$DestinationBackup' => 'Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup.
You will need to use the sourceBackupID
returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.
The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.
', 'Hsm$EniId' => 'The identifier (ID) of the HSM\'s elastic network interface (ENI).
', ], ], 'ExternalAz' => [ 'base' => NULL, 'refs' => [ 'CreateHsmRequest$AvailabilityZone' => 'The Availability Zone where you are creating the HSM. To find the cluster\'s Availability Zones, use DescribeClusters.
', 'ExternalSubnetMapping$key' => NULL, 'Hsm$AvailabilityZone' => 'The Availability Zone that contains the HSM.
', ], ], 'ExternalSubnetMapping' => [ 'base' => NULL, 'refs' => [ 'Cluster$SubnetMapping' => 'A map from availability zone to the cluster’s subnet in that availability zone.
', ], ], 'Field' => [ 'base' => NULL, 'refs' => [ 'Filters$key' => NULL, ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsRequest$Filters' => 'One or more filters to limit the items returned in the response.
Use the backupIds
filter to return only the specified backups. Specify backups by their backup identifier (ID).
Use the sourceBackupIds
filter to return only the backups created from a source backup. The sourceBackupID
of a source backup is returned by the CopyBackupToRegion operation.
Use the clusterIds
filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).
Use the states
filter to return only backups that match the specified state.
Use the neverExpires
filter to return backups filtered by the value in the neverExpires
parameter. True
returns all backups exempt from the backup retention policy. False
returns all backups with a backup retention policy defined at the cluster.
One or more filters to limit the items returned in the response.
Use the clusterIds
filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).
Use the vpcIds
filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).
Use the states
filter to return only clusters that match the specified state.
Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
', 'refs' => [ 'CreateHsmResponse$Hsm' => 'Information about the HSM that was created.
', 'Hsms$member' => NULL, ], ], 'HsmId' => [ 'base' => NULL, 'refs' => [ 'DeleteHsmRequest$HsmId' => 'The identifier (ID) of the HSM that you are deleting.
', 'DeleteHsmResponse$HsmId' => 'The identifier (ID) of the HSM that was deleted.
', 'Hsm$HsmId' => 'The HSM\'s identifier (ID).
', ], ], 'HsmState' => [ 'base' => NULL, 'refs' => [ 'Hsm$State' => 'The HSM\'s state.
', ], ], 'HsmType' => [ 'base' => NULL, 'refs' => [ 'Backup$HsmType' => 'The HSM type of the cluster that was backed up.
', 'Cluster$HsmType' => 'The type of HSM that the cluster contains.
', 'CreateClusterRequest$HsmType' => 'The type of HSM to use in the cluster. The allowed values are hsm1.medium
and hsm2m.medium
.
Contains information about the HSMs in the cluster.
', ], ], 'InitializeClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'InitializeClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'CreateHsmRequest$IpAddress' => 'The HSM\'s IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don\'t specify an IP address, one is chosen for you from that subnet.
', 'DeleteHsmRequest$EniIp' => 'The IP address of the elastic network interface (ENI) of the HSM that you are deleting.
', 'Hsm$EniIp' => 'The IP address of the HSM\'s elastic network interface (ENI).
', ], ], 'ListTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxSize' => [ 'base' => NULL, 'refs' => [ 'ListTagsRequest$MaxResults' => 'The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken
value.
The NextToken
value that you received in the previous response. Use this value to get more backups.
An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups
request to get more backups.
The NextToken
value that you received in the previous response. Use this value to get more clusters.
An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters
request to get more clusters.
The NextToken
value that you received in the previous response. Use this value to get more tags.
An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags
request to get more tags.
The default password for the cluster\'s Pre-Crypto Officer (PRECO) user.
', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'Backup$SourceRegion' => 'The AWS Region that contains the source backup from which the new backup was copied.
', 'CopyBackupToRegionRequest$DestinationRegion' => 'The AWS region that will contain your copied CloudHSM cluster backup.
', 'DestinationBackup$SourceRegion' => 'The AWS region that contains the source backup from which the new backup was copied.
', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ListTagsRequest$ResourceId' => 'The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.
', 'TagResourceRequest$ResourceId' => 'The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.
', 'UntagResourceRequest$ResourceId' => 'The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.
', ], ], 'RestoreBackupRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreBackupResponse' => [ 'base' => NULL, 'refs' => [], ], 'SecurityGroup' => [ 'base' => NULL, 'refs' => [ 'Cluster$SecurityGroup' => 'The identifier (ID) of the cluster\'s security group.
', ], ], 'StateMessage' => [ 'base' => NULL, 'refs' => [ 'Cluster$StateMessage' => 'A description of the cluster\'s state.
', 'InitializeClusterResponse$StateMessage' => 'A description of the cluster\'s state.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Hsm$StateMessage' => 'A description of the HSM\'s state.
', 'Strings$member' => NULL, ], ], 'Strings' => [ 'base' => NULL, 'refs' => [ 'Filters$value' => NULL, ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'ExternalSubnetMapping$value' => NULL, 'Hsm$SubnetId' => 'The subnet that contains the HSM\'s elastic network interface (ENI).
', 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'CreateClusterRequest$SubnetIds' => 'The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:
All subnets must be in the same virtual private cloud (VPC).
You can specify only one subnet per Availability Zone.
Contains a tag. A tag is a key-value pair.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key of the tag.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeyList' => 'A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'Backup$TagList' => 'The list of tags for the backup.
', 'Cluster$TagList' => 'The list of tags for the cluster.
', 'CopyBackupToRegionRequest$TagList' => 'Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.
', 'CreateClusterRequest$TagList' => 'Tags to apply to the CloudHSM cluster during creation.
', 'ListTagsResponse$TagList' => 'A list of tags.
', 'TagResourceRequest$TagList' => 'A list of one or more tags.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value of the tag.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Backup$CreateTimestamp' => 'The date and time when the backup was created.
', 'Backup$CopyTimestamp' => 'The date and time when the backup was copied from a source backup.
', 'Backup$DeleteTimestamp' => 'The date and time when the backup will be permanently deleted.
', 'Cluster$CreateTimestamp' => 'The date and time when the cluster was created.
', 'DestinationBackup$CreateTimestamp' => 'The date and time when both the source backup was created.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'Cluster$VpcId' => 'The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
', ], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'CloudHsmAccessDeniedException$Message' => NULL, 'CloudHsmInternalFailureException$Message' => NULL, 'CloudHsmInvalidRequestException$Message' => NULL, 'CloudHsmResourceNotFoundException$Message' => NULL, 'CloudHsmServiceException$Message' => NULL, 'CloudHsmTagException$Message' => NULL, ], ], ],]; +return [ 'version' => '2.0', 'service' => 'For more information about CloudHSM, see CloudHSM and the CloudHSM User Guide.
', 'operations' => [ 'CopyBackupToRegion' => 'Copy an CloudHSM cluster backup to a different region.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
', 'CreateCluster' => 'Creates a new CloudHSM cluster.
Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.
', 'CreateHsm' => 'Creates a new hardware security module (HSM) in the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.
', 'DeleteBackup' => 'Deletes a specified CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
', 'DeleteCluster' => 'Deletes the specified CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
', 'DeleteHsm' => 'Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM\'s elastic network interface (ENI), or the ID of the HSM\'s ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.
', 'DeleteResourcePolicy' => 'Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
', 'DescribeBackups' => 'Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken
value. Use this value in a subsequent DescribeBackups
request to get more backups. When you receive a response with no NextToken
(or an empty or null value), that means there are no more backups to get.
Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.
', 'DescribeClusters' => 'Gets information about CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken
value. Use this value in a subsequent DescribeClusters
request to get more clusters. When you receive a response with no NextToken
(or an empty or null value), that means there are no more clusters to get.
Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.
', 'GetResourcePolicy' => 'Retrieves the resource policy document attached to a given resource.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
', 'InitializeCluster' => 'Claims an CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA\'s root certificate. Before you can claim a cluster, you must sign the cluster\'s certificate signing request (CSR) with your issuing CA. To get the cluster\'s CSR, use DescribeClusters.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
', 'ListTags' => 'Gets a list of tags for the specified CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken
value. Use this value in a subsequent ListTags
request to get more tags. When you receive a response with no NextToken
(or an empty or null value), that means there are no more tags to get.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
', 'ModifyBackupAttributes' => 'Modifies attributes for CloudHSM backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
', 'ModifyCluster' => 'Modifies CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
', 'PutResourcePolicy' => 'Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies:
Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.
In order to share a backup, it must be in a \'READY\' state and you must own it.
While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to describe the backups you share with them, you must promote the backup to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information, see Working with shared backups in the CloudHSM User Guide
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
', 'RestoreBackup' => 'Restores a specified CloudHSM backup that is in the PENDING_DELETION
state. For more information on deleting a backup, see DeleteBackup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
', 'TagResource' => 'Adds or overwrites one or more tags for the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
', 'UntagResource' => 'Removes the specified tag or tags from the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
', ], 'shapes' => [ 'Backup' => [ 'base' => 'Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId
, BackupState
, ClusterId
, and CreateTimestamp
parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp
, SourceBackup
, SourceCluster
, and SourceRegion
parameters. A backup that is pending deletion will include the DeleteTimestamp
parameter.
Information on the Backup
object deleted.
Information on the Backup
object created.
The Amazon Resource Name (ARN) of the backup.
', 'CreateClusterRequest$SourceBackupId' => 'The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.
', ], ], 'BackupId' => [ 'base' => NULL, 'refs' => [ 'Backup$BackupId' => 'The identifier (ID) of the backup.
', 'Backup$SourceBackup' => 'The identifier (ID) of the source backup from which the new backup was copied.
', 'Cluster$SourceBackupId' => 'The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
', 'CopyBackupToRegionRequest$BackupId' => 'The ID of the backup that will be copied to the destination region.
', 'DeleteBackupRequest$BackupId' => 'The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
', 'DestinationBackup$SourceBackup' => 'The identifier (ID) of the source backup from which the new backup was copied.
', 'ModifyBackupAttributesRequest$BackupId' => 'The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.
', 'RestoreBackupRequest$BackupId' => 'The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
', ], ], 'BackupPolicy' => [ 'base' => NULL, 'refs' => [ 'Cluster$BackupPolicy' => 'The cluster\'s backup policy.
', ], ], 'BackupRetentionPolicy' => [ 'base' => 'A policy that defines the number of days to retain backups.
', 'refs' => [ 'Cluster$BackupRetentionPolicy' => 'A policy that defines how the service retains backups.
', 'CreateClusterRequest$BackupRetentionPolicy' => 'A policy that defines how the service retains backups.
', 'ModifyClusterRequest$BackupRetentionPolicy' => 'A policy that defines how the service retains backups.
', ], ], 'BackupRetentionType' => [ 'base' => NULL, 'refs' => [ 'BackupRetentionPolicy$Type' => 'The type of backup retention policy. For the DAYS
type, the value is the number of days to retain backups.
Use a value between 7 - 379.
', ], ], 'BackupState' => [ 'base' => NULL, 'refs' => [ 'Backup$BackupState' => 'The state of the backup.
', ], ], 'Backups' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsResponse$Backups' => 'A list of backups.
', ], ], 'BackupsMaxSize' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsRequest$MaxResults' => 'The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken
value.
Specifies whether the service should exempt a backup from the retention policy for the cluster. True
exempts a backup from the retention policy. False
means the service applies the backup retention policy defined at the cluster.
Describe backups that are shared with you.
By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.
Designates whether or not to sort the return backups by ascending chronological order of generation.
', 'ModifyBackupAttributesRequest$NeverExpires' => 'Specifies whether the service should exempt a backup from the retention policy for the cluster. True
exempts a backup from the retention policy. False
means the service applies the backup retention policy defined at the cluster.
The cluster\'s certificate signing request (CSR). The CSR exists only when the cluster\'s state is UNINITIALIZED
.
The HSM certificate issued (signed) by the HSM hardware.
', 'Certificates$AwsHardwareCertificate' => 'The HSM hardware certificate issued (signed) by CloudHSM.
', 'Certificates$ManufacturerHardwareCertificate' => 'The HSM hardware certificate issued (signed) by the hardware manufacturer.
', 'Certificates$ClusterCertificate' => 'The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster\'s owner.
', 'InitializeClusterRequest$SignedCert' => 'The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.
', 'InitializeClusterRequest$TrustAnchor' => 'The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.
', ], ], 'Certificates' => [ 'base' => 'Contains one or more certificates or a certificate signing request (CSR).
', 'refs' => [ 'Cluster$Certificates' => 'Contains one or more certificates or a certificate signing request (CSR).
', ], ], 'CloudHsmAccessDeniedException' => [ 'base' => 'The request was rejected because the requester does not have permission to perform the requested operation.
', 'refs' => [], ], 'CloudHsmArn' => [ 'base' => NULL, 'refs' => [ 'DeleteResourcePolicyRequest$ResourceArn' => 'Amazon Resource Name (ARN) of the resource from which the policy will be removed.
', 'DeleteResourcePolicyResponse$ResourceArn' => 'Amazon Resource Name (ARN) of the resource from which the policy was deleted.
', 'GetResourcePolicyRequest$ResourceArn' => 'Amazon Resource Name (ARN) of the resource to which a policy is attached.
', 'PutResourcePolicyRequest$ResourceArn' => 'Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
', 'PutResourcePolicyResponse$ResourceArn' => 'Amazon Resource Name (ARN) of the resource to which a policy is attached.
', ], ], 'CloudHsmInternalFailureException' => [ 'base' => 'The request was rejected because of an CloudHSM internal failure. The request can be retried.
', 'refs' => [], ], 'CloudHsmInvalidRequestException' => [ 'base' => 'The request was rejected because it is not a valid request.
', 'refs' => [], ], 'CloudHsmResourceNotFoundException' => [ 'base' => 'The request was rejected because it refers to a resource that cannot be found.
', 'refs' => [], ], 'CloudHsmServiceException' => [ 'base' => 'The request was rejected because an error occurred.
', 'refs' => [], ], 'CloudHsmTagException' => [ 'base' => 'The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
', 'refs' => [], ], 'Cluster' => [ 'base' => 'Contains information about an CloudHSM cluster.
', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$Cluster' => 'Information about the cluster that was created.
', 'DeleteClusterResponse$Cluster' => 'Information about the cluster that was deleted.
', 'ModifyClusterResponse$Cluster' => NULL, ], ], 'ClusterId' => [ 'base' => NULL, 'refs' => [ 'Backup$ClusterId' => 'The identifier (ID) of the cluster that was backed up.
', 'Backup$SourceCluster' => 'The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
', 'Cluster$ClusterId' => 'The cluster\'s identifier (ID).
', 'CreateHsmRequest$ClusterId' => 'The identifier (ID) of the HSM\'s cluster. To find the cluster ID, use DescribeClusters.
', 'DeleteClusterRequest$ClusterId' => 'The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.
', 'DeleteHsmRequest$ClusterId' => 'The identifier (ID) of the cluster that contains the HSM that you are deleting.
', 'DestinationBackup$SourceCluster' => 'The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
', 'Hsm$ClusterId' => 'The identifier (ID) of the cluster that contains the HSM.
', 'InitializeClusterRequest$ClusterId' => 'The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.
', 'ModifyClusterRequest$ClusterId' => 'The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.
', ], ], 'ClusterMode' => [ 'base' => NULL, 'refs' => [ 'Backup$Mode' => 'The mode of the cluster that was backed up.
', 'Cluster$Mode' => 'The mode of the cluster.
', 'CreateClusterRequest$Mode' => 'The mode to use in the cluster. The allowed values are FIPS
and NON_FIPS
.
The cluster\'s state.
', 'InitializeClusterResponse$State' => 'The cluster\'s state.
', ], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$Clusters' => 'A list of clusters.
', ], ], 'ClustersMaxSize' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$MaxResults' => 'The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken
value.
Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.
', 'refs' => [ 'CopyBackupToRegionResponse$DestinationBackup' => 'Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup.
You will need to use the sourceBackupID
returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.
The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.
', 'Hsm$EniId' => 'The identifier (ID) of the HSM\'s elastic network interface (ENI).
', ], ], 'ExternalAz' => [ 'base' => NULL, 'refs' => [ 'CreateHsmRequest$AvailabilityZone' => 'The Availability Zone where you are creating the HSM. To find the cluster\'s Availability Zones, use DescribeClusters.
', 'ExternalSubnetMapping$key' => NULL, 'Hsm$AvailabilityZone' => 'The Availability Zone that contains the HSM.
', ], ], 'ExternalSubnetMapping' => [ 'base' => NULL, 'refs' => [ 'Cluster$SubnetMapping' => 'A map from availability zone to the cluster’s subnet in that availability zone.
', ], ], 'Field' => [ 'base' => NULL, 'refs' => [ 'Filters$key' => NULL, ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsRequest$Filters' => 'One or more filters to limit the items returned in the response.
Use the backupIds
filter to return only the specified backups. Specify backups by their backup identifier (ID).
Use the sourceBackupIds
filter to return only the backups created from a source backup. The sourceBackupID
of a source backup is returned by the CopyBackupToRegion operation.
Use the clusterIds
filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).
Use the states
filter to return only backups that match the specified state.
Use the neverExpires
filter to return backups filtered by the value in the neverExpires
parameter. True
returns all backups exempt from the backup retention policy. False
returns all backups with a backup retention policy defined at the cluster.
One or more filters to limit the items returned in the response.
Use the clusterIds
filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).
Use the vpcIds
filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).
Use the states
filter to return only clusters that match the specified state.
Contains information about a hardware security module (HSM) in an CloudHSM cluster.
', 'refs' => [ 'CreateHsmResponse$Hsm' => 'Information about the HSM that was created.
', 'Hsms$member' => NULL, ], ], 'HsmId' => [ 'base' => NULL, 'refs' => [ 'DeleteHsmRequest$HsmId' => 'The identifier (ID) of the HSM that you are deleting.
', 'DeleteHsmResponse$HsmId' => 'The identifier (ID) of the HSM that was deleted.
', 'Hsm$HsmId' => 'The HSM\'s identifier (ID).
', ], ], 'HsmState' => [ 'base' => NULL, 'refs' => [ 'Hsm$State' => 'The HSM\'s state.
', ], ], 'HsmType' => [ 'base' => NULL, 'refs' => [ 'Backup$HsmType' => 'The HSM type used to create the backup.
', 'Cluster$HsmType' => 'The type of HSM that the cluster contains.
', 'CreateClusterRequest$HsmType' => 'The type of HSM to use in the cluster. The allowed values are hsm1.medium
and hsm2m.medium
.
Contains information about the HSMs in the cluster.
', ], ], 'InitializeClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'InitializeClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'CreateHsmRequest$IpAddress' => 'The HSM\'s IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don\'t specify an IP address, one is chosen for you from that subnet.
', 'DeleteHsmRequest$EniIp' => 'The IP address of the elastic network interface (ENI) of the HSM that you are deleting.
', 'Hsm$EniIp' => 'The IP address of the HSM\'s elastic network interface (ENI).
', ], ], 'ListTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxSize' => [ 'base' => NULL, 'refs' => [ 'ListTagsRequest$MaxResults' => 'The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken
value.
The NextToken
value that you received in the previous response. Use this value to get more backups.
An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups
request to get more backups.
The NextToken
value that you received in the previous response. Use this value to get more clusters.
An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters
request to get more clusters.
The NextToken
value that you received in the previous response. Use this value to get more tags.
An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags
request to get more tags.
The default password for the cluster\'s Pre-Crypto Officer (PRECO) user.
', ], ], 'PutResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'Backup$SourceRegion' => 'The AWS Region that contains the source backup from which the new backup was copied.
', 'CopyBackupToRegionRequest$DestinationRegion' => 'The AWS region that will contain your copied CloudHSM cluster backup.
', 'DestinationBackup$SourceRegion' => 'The AWS region that contains the source backup from which the new backup was copied.
', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ListTagsRequest$ResourceId' => 'The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.
', 'TagResourceRequest$ResourceId' => 'The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.
', 'UntagResourceRequest$ResourceId' => 'The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.
', ], ], 'ResourcePolicy' => [ 'base' => NULL, 'refs' => [ 'DeleteResourcePolicyResponse$Policy' => 'The policy previously attached to the resource.
', 'GetResourcePolicyResponse$Policy' => 'The policy attached to a resource.
', 'PutResourcePolicyRequest$Policy' => 'The policy you want to associate with a resource.
For an example policy, see Working with shared backups in the CloudHSM User Guide
', 'PutResourcePolicyResponse$Policy' => 'The policy attached to a resource.
', ], ], 'RestoreBackupRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreBackupResponse' => [ 'base' => NULL, 'refs' => [], ], 'SecurityGroup' => [ 'base' => NULL, 'refs' => [ 'Cluster$SecurityGroup' => 'The identifier (ID) of the cluster\'s security group.
', ], ], 'StateMessage' => [ 'base' => NULL, 'refs' => [ 'Cluster$StateMessage' => 'A description of the cluster\'s state.
', 'InitializeClusterResponse$StateMessage' => 'A description of the cluster\'s state.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Hsm$StateMessage' => 'A description of the HSM\'s state.
', 'Strings$member' => NULL, ], ], 'Strings' => [ 'base' => NULL, 'refs' => [ 'Filters$value' => NULL, ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'ExternalSubnetMapping$value' => NULL, 'Hsm$SubnetId' => 'The subnet that contains the HSM\'s elastic network interface (ENI).
', 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'CreateClusterRequest$SubnetIds' => 'The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:
All subnets must be in the same virtual private cloud (VPC).
You can specify only one subnet per Availability Zone.
Contains a tag. A tag is a key-value pair.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key of the tag.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeyList' => 'A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'Backup$TagList' => 'The list of tags for the backup.
', 'Cluster$TagList' => 'The list of tags for the cluster.
', 'CopyBackupToRegionRequest$TagList' => 'Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.
', 'CreateClusterRequest$TagList' => 'Tags to apply to the CloudHSM cluster during creation.
', 'ListTagsResponse$TagList' => 'A list of tags.
', 'TagResourceRequest$TagList' => 'A list of one or more tags.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value of the tag.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Backup$CreateTimestamp' => 'The date and time when the backup was created.
', 'Backup$CopyTimestamp' => 'The date and time when the backup was copied from a source backup.
', 'Backup$DeleteTimestamp' => 'The date and time when the backup will be permanently deleted.
', 'Cluster$CreateTimestamp' => 'The date and time when the cluster was created.
', 'DestinationBackup$CreateTimestamp' => 'The date and time when both the source backup was created.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'Cluster$VpcId' => 'The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
', ], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'CloudHsmAccessDeniedException$Message' => NULL, 'CloudHsmInternalFailureException$Message' => NULL, 'CloudHsmInvalidRequestException$Message' => NULL, 'CloudHsmResourceNotFoundException$Message' => NULL, 'CloudHsmServiceException$Message' => NULL, 'CloudHsmTagException$Message' => NULL, ], ], ],]; diff --git a/src/data/connect/2017-08-08/api-2.json b/src/data/connect/2017-08-08/api-2.json index 8560e5b71f..3490a144e9 100644 --- a/src/data/connect/2017-08-08/api-2.json +++ b/src/data/connect/2017-08-08/api-2.json @@ -11,7 +11,8 @@ "serviceId":"Connect", "signatureVersion":"v4", "signingName":"connect", - "uid":"connect-2017-08-08" + "uid":"connect-2017-08-08", + "auth":["aws.auth#sigv4"] }, "operations":{ "ActivateEvaluationForm":{ @@ -4193,6 +4194,14 @@ "L5Ids":{"shape":"HierarchyGroupIdList"} } }, + "AgentId":{ + "type":"string", + "max":256 + }, + "AgentIds":{ + "type":"list", + "member":{"shape":"AgentId"} + }, "AgentInfo":{ "type":"structure", "members":{ @@ -4310,6 +4319,12 @@ "max":100, "min":1 }, + "AgentsCriteria":{ + "type":"structure", + "members":{ + "AgentIds":{"shape":"AgentIds"} + } + }, "AgentsMinOneMaxHundred":{ "type":"list", "member":{"shape":"UserId"}, @@ -4792,7 +4807,8 @@ "members":{ "Name":{"shape":"PredefinedAttributeName"}, "Value":{"shape":"ProficiencyValue"}, - "ProficiencyLevel":{"shape":"ProficiencyLevel"}, + "ProficiencyLevel":{"shape":"NullableProficiencyLevel"}, + "MatchCriteria":{"shape":"MatchCriteria"}, "ComparisonOperator":{"shape":"ComparisonOperator"} } }, @@ -11258,6 +11274,12 @@ } }, "Long":{"type":"long"}, + "MatchCriteria":{ + "type":"structure", + "members":{ + "AgentsCriteria":{"shape":"AgentsCriteria"} + } + }, "MaxResult10":{ "type":"integer", "max":10, @@ -11519,6 +11541,11 @@ "UserIds":{"shape":"UserIdList"} } }, + "NullableProficiencyLevel":{ + "type":"float", + "max":5.0, + "min":1.0 + }, "NumberReference":{ "type":"structure", "members":{ diff --git a/src/data/connect/2017-08-08/api-2.json.php b/src/data/connect/2017-08-08/api-2.json.php index e046e726da..a43a96cfb6 100644 --- a/src/data/connect/2017-08-08/api-2.json.php +++ b/src/data/connect/2017-08-08/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2017-08-08', 'endpointPrefix' => 'connect', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceAbbreviation' => 'Amazon Connect', 'serviceFullName' => 'Amazon Connect Service', 'serviceId' => 'Connect', 'signatureVersion' => 'v4', 'signingName' => 'connect', 'uid' => 'connect-2017-08-08', ], 'operations' => [ 'ActivateEvaluationForm' => [ 'name' => 'ActivateEvaluationForm', 'http' => [ 'method' => 'POST', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}/activate', ], 'input' => [ 'shape' => 'ActivateEvaluationFormRequest', ], 'output' => [ 'shape' => 'ActivateEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'AssociateAnalyticsDataSet' => [ 'name' => 'AssociateAnalyticsDataSet', 'http' => [ 'method' => 'PUT', 'requestUri' => '/analytics-data/instance/{InstanceId}/association', ], 'input' => [ 'shape' => 'AssociateAnalyticsDataSetRequest', ], 'output' => [ 'shape' => 'AssociateAnalyticsDataSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'AssociateApprovedOrigin' => [ 'name' => 'AssociateApprovedOrigin', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/approved-origin', ], 'input' => [ 'shape' => 'AssociateApprovedOriginRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateBot' => [ 'name' => 'AssociateBot', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/bot', ], 'input' => [ 'shape' => 'AssociateBotRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateDefaultVocabulary' => [ 'name' => 'AssociateDefaultVocabulary', 'http' => [ 'method' => 'PUT', 'requestUri' => '/default-vocabulary/{InstanceId}/{LanguageCode}', ], 'input' => [ 'shape' => 'AssociateDefaultVocabularyRequest', ], 'output' => [ 'shape' => 'AssociateDefaultVocabularyResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'AssociateFlow' => [ 'name' => 'AssociateFlow', 'http' => [ 'method' => 'PUT', 'requestUri' => '/flow-associations/{InstanceId}', ], 'input' => [ 'shape' => 'AssociateFlowRequest', ], 'output' => [ 'shape' => 'AssociateFlowResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateInstanceStorageConfig' => [ 'name' => 'AssociateInstanceStorageConfig', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/storage-config', ], 'input' => [ 'shape' => 'AssociateInstanceStorageConfigRequest', ], 'output' => [ 'shape' => 'AssociateInstanceStorageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateLambdaFunction' => [ 'name' => 'AssociateLambdaFunction', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/lambda-function', ], 'input' => [ 'shape' => 'AssociateLambdaFunctionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateLexBot' => [ 'name' => 'AssociateLexBot', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/lex-bot', ], 'input' => [ 'shape' => 'AssociateLexBotRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociatePhoneNumberContactFlow' => [ 'name' => 'AssociatePhoneNumberContactFlow', 'http' => [ 'method' => 'PUT', 'requestUri' => '/phone-number/{PhoneNumberId}/contact-flow', ], 'input' => [ 'shape' => 'AssociatePhoneNumberContactFlowRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'AssociateQueueQuickConnects' => [ 'name' => 'AssociateQueueQuickConnects', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/associate-quick-connects', ], 'input' => [ 'shape' => 'AssociateQueueQuickConnectsRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'AssociateRoutingProfileQueues' => [ 'name' => 'AssociateRoutingProfileQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues', ], 'input' => [ 'shape' => 'AssociateRoutingProfileQueuesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'AssociateSecurityKey' => [ 'name' => 'AssociateSecurityKey', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/security-key', ], 'input' => [ 'shape' => 'AssociateSecurityKeyRequest', ], 'output' => [ 'shape' => 'AssociateSecurityKeyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateTrafficDistributionGroupUser' => [ 'name' => 'AssociateTrafficDistributionGroupUser', 'http' => [ 'method' => 'PUT', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}/user', ], 'input' => [ 'shape' => 'AssociateTrafficDistributionGroupUserRequest', ], 'output' => [ 'shape' => 'AssociateTrafficDistributionGroupUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], ], 'idempotent' => true, ], 'AssociateUserProficiencies' => [ 'name' => 'AssociateUserProficiencies', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/associate-proficiencies', ], 'input' => [ 'shape' => 'AssociateUserProficienciesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'BatchAssociateAnalyticsDataSet' => [ 'name' => 'BatchAssociateAnalyticsDataSet', 'http' => [ 'method' => 'PUT', 'requestUri' => '/analytics-data/instance/{InstanceId}/associations', ], 'input' => [ 'shape' => 'BatchAssociateAnalyticsDataSetRequest', ], 'output' => [ 'shape' => 'BatchAssociateAnalyticsDataSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'BatchDisassociateAnalyticsDataSet' => [ 'name' => 'BatchDisassociateAnalyticsDataSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/analytics-data/instance/{InstanceId}/associations', ], 'input' => [ 'shape' => 'BatchDisassociateAnalyticsDataSetRequest', ], 'output' => [ 'shape' => 'BatchDisassociateAnalyticsDataSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'BatchGetAttachedFileMetadata' => [ 'name' => 'BatchGetAttachedFileMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/attached-files/{InstanceId}', ], 'input' => [ 'shape' => 'BatchGetAttachedFileMetadataRequest', ], 'output' => [ 'shape' => 'BatchGetAttachedFileMetadataResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'BatchGetFlowAssociation' => [ 'name' => 'BatchGetFlowAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/flow-associations-batch/{InstanceId}', ], 'input' => [ 'shape' => 'BatchGetFlowAssociationRequest', ], 'output' => [ 'shape' => 'BatchGetFlowAssociationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'BatchPutContact' => [ 'name' => 'BatchPutContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/batch/{InstanceId}', ], 'input' => [ 'shape' => 'BatchPutContactRequest', ], 'output' => [ 'shape' => 'BatchPutContactResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'IdempotencyException', ], ], 'idempotent' => true, ], 'ClaimPhoneNumber' => [ 'name' => 'ClaimPhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number/claim', ], 'input' => [ 'shape' => 'ClaimPhoneNumberRequest', ], 'output' => [ 'shape' => 'ClaimPhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CompleteAttachedFileUpload' => [ 'name' => 'CompleteAttachedFileUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/attached-files/{InstanceId}/{FileId}', ], 'input' => [ 'shape' => 'CompleteAttachedFileUploadRequest', ], 'output' => [ 'shape' => 'CompleteAttachedFileUploadResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateAgentStatus' => [ 'name' => 'CreateAgentStatus', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agent-status/{InstanceId}', ], 'input' => [ 'shape' => 'CreateAgentStatusRequest', ], 'output' => [ 'shape' => 'CreateAgentStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateContactFlow' => [ 'name' => 'CreateContactFlow', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact-flows/{InstanceId}', ], 'input' => [ 'shape' => 'CreateContactFlowRequest', ], 'output' => [ 'shape' => 'CreateContactFlowResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidContactFlowException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateContactFlowModule' => [ 'name' => 'CreateContactFlowModule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact-flow-modules/{InstanceId}', ], 'input' => [ 'shape' => 'CreateContactFlowModuleRequest', ], 'output' => [ 'shape' => 'CreateContactFlowModuleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidContactFlowModuleException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateEvaluationForm' => [ 'name' => 'CreateEvaluationForm', 'http' => [ 'method' => 'PUT', 'requestUri' => '/evaluation-forms/{InstanceId}', ], 'input' => [ 'shape' => 'CreateEvaluationFormRequest', ], 'output' => [ 'shape' => 'CreateEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'CreateHoursOfOperation' => [ 'name' => 'CreateHoursOfOperation', 'http' => [ 'method' => 'PUT', 'requestUri' => '/hours-of-operations/{InstanceId}', ], 'input' => [ 'shape' => 'CreateHoursOfOperationRequest', ], 'output' => [ 'shape' => 'CreateHoursOfOperationResponse', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateInstance' => [ 'name' => 'CreateInstance', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance', ], 'input' => [ 'shape' => 'CreateInstanceRequest', ], 'output' => [ 'shape' => 'CreateInstanceResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateIntegrationAssociation' => [ 'name' => 'CreateIntegrationAssociation', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/integration-associations', ], 'input' => [ 'shape' => 'CreateIntegrationAssociationRequest', ], 'output' => [ 'shape' => 'CreateIntegrationAssociationResponse', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateParticipant' => [ 'name' => 'CreateParticipant', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/create-participant', ], 'input' => [ 'shape' => 'CreateParticipantRequest', ], 'output' => [ 'shape' => 'CreateParticipantResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreatePersistentContactAssociation' => [ 'name' => 'CreatePersistentContactAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/persistent-contact-association/{InstanceId}/{InitialContactId}', ], 'input' => [ 'shape' => 'CreatePersistentContactAssociationRequest', ], 'output' => [ 'shape' => 'CreatePersistentContactAssociationResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreatePredefinedAttribute' => [ 'name' => 'CreatePredefinedAttribute', 'http' => [ 'method' => 'PUT', 'requestUri' => '/predefined-attributes/{InstanceId}', ], 'input' => [ 'shape' => 'CreatePredefinedAttributeRequest', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreatePrompt' => [ 'name' => 'CreatePrompt', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prompts/{InstanceId}', ], 'input' => [ 'shape' => 'CreatePromptRequest', ], 'output' => [ 'shape' => 'CreatePromptResponse', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateQueue' => [ 'name' => 'CreateQueue', 'http' => [ 'method' => 'PUT', 'requestUri' => '/queues/{InstanceId}', ], 'input' => [ 'shape' => 'CreateQueueRequest', ], 'output' => [ 'shape' => 'CreateQueueResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateQuickConnect' => [ 'name' => 'CreateQuickConnect', 'http' => [ 'method' => 'PUT', 'requestUri' => '/quick-connects/{InstanceId}', ], 'input' => [ 'shape' => 'CreateQuickConnectRequest', ], 'output' => [ 'shape' => 'CreateQuickConnectResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateRoutingProfile' => [ 'name' => 'CreateRoutingProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/routing-profiles/{InstanceId}', ], 'input' => [ 'shape' => 'CreateRoutingProfileRequest', ], 'output' => [ 'shape' => 'CreateRoutingProfileResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateRule' => [ 'name' => 'CreateRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/rules/{InstanceId}', ], 'input' => [ 'shape' => 'CreateRuleRequest', ], 'output' => [ 'shape' => 'CreateRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'CreateSecurityProfile' => [ 'name' => 'CreateSecurityProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/security-profiles/{InstanceId}', ], 'input' => [ 'shape' => 'CreateSecurityProfileRequest', ], 'output' => [ 'shape' => 'CreateSecurityProfileResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateTaskTemplate' => [ 'name' => 'CreateTaskTemplate', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/task/template', ], 'input' => [ 'shape' => 'CreateTaskTemplateRequest', ], 'output' => [ 'shape' => 'CreateTaskTemplateResponse', ], 'errors' => [ [ 'shape' => 'PropertyValidationException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateTrafficDistributionGroup' => [ 'name' => 'CreateTrafficDistributionGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/traffic-distribution-group', ], 'input' => [ 'shape' => 'CreateTrafficDistributionGroupRequest', ], 'output' => [ 'shape' => 'CreateTrafficDistributionGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ResourceNotReadyException', ], ], ], 'CreateUseCase' => [ 'name' => 'CreateUseCase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases', ], 'input' => [ 'shape' => 'CreateUseCaseRequest', ], 'output' => [ 'shape' => 'CreateUseCaseResponse', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateUser' => [ 'name' => 'CreateUser', 'http' => [ 'method' => 'PUT', 'requestUri' => '/users/{InstanceId}', ], 'input' => [ 'shape' => 'CreateUserRequest', ], 'output' => [ 'shape' => 'CreateUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateUserHierarchyGroup' => [ 'name' => 'CreateUserHierarchyGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/user-hierarchy-groups/{InstanceId}', ], 'input' => [ 'shape' => 'CreateUserHierarchyGroupRequest', ], 'output' => [ 'shape' => 'CreateUserHierarchyGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateView' => [ 'name' => 'CreateView', 'http' => [ 'method' => 'PUT', 'requestUri' => '/views/{InstanceId}', ], 'input' => [ 'shape' => 'CreateViewRequest', ], 'output' => [ 'shape' => 'CreateViewResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'CreateViewVersion' => [ 'name' => 'CreateViewVersion', 'http' => [ 'method' => 'PUT', 'requestUri' => '/views/{InstanceId}/{ViewId}/versions', ], 'input' => [ 'shape' => 'CreateViewVersionRequest', ], 'output' => [ 'shape' => 'CreateViewVersionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'CreateVocabulary' => [ 'name' => 'CreateVocabulary', 'http' => [ 'method' => 'POST', 'requestUri' => '/vocabulary/{InstanceId}', ], 'input' => [ 'shape' => 'CreateVocabularyRequest', ], 'output' => [ 'shape' => 'CreateVocabularyResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'DeactivateEvaluationForm' => [ 'name' => 'DeactivateEvaluationForm', 'http' => [ 'method' => 'POST', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}/deactivate', ], 'input' => [ 'shape' => 'DeactivateEvaluationFormRequest', ], 'output' => [ 'shape' => 'DeactivateEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'DeleteAttachedFile' => [ 'name' => 'DeleteAttachedFile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/attached-files/{InstanceId}/{FileId}', ], 'input' => [ 'shape' => 'DeleteAttachedFileRequest', ], 'output' => [ 'shape' => 'DeleteAttachedFileResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteContactEvaluation' => [ 'name' => 'DeleteContactEvaluation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/contact-evaluations/{InstanceId}/{EvaluationId}', ], 'input' => [ 'shape' => 'DeleteContactEvaluationRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'DeleteContactFlow' => [ 'name' => 'DeleteContactFlow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}', ], 'input' => [ 'shape' => 'DeleteContactFlowRequest', ], 'output' => [ 'shape' => 'DeleteContactFlowResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteContactFlowModule' => [ 'name' => 'DeleteContactFlowModule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}', ], 'input' => [ 'shape' => 'DeleteContactFlowModuleRequest', ], 'output' => [ 'shape' => 'DeleteContactFlowModuleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteEvaluationForm' => [ 'name' => 'DeleteEvaluationForm', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}', ], 'input' => [ 'shape' => 'DeleteEvaluationFormRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'DeleteHoursOfOperation' => [ 'name' => 'DeleteHoursOfOperation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/hours-of-operations/{InstanceId}/{HoursOfOperationId}', ], 'input' => [ 'shape' => 'DeleteHoursOfOperationRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteInstance' => [ 'name' => 'DeleteInstance', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}', ], 'input' => [ 'shape' => 'DeleteInstanceRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteIntegrationAssociation' => [ 'name' => 'DeleteIntegrationAssociation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}', ], 'input' => [ 'shape' => 'DeleteIntegrationAssociationRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeletePredefinedAttribute' => [ 'name' => 'DeletePredefinedAttribute', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/predefined-attributes/{InstanceId}/{Name}', ], 'input' => [ 'shape' => 'DeletePredefinedAttributeRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], 'idempotent' => true, ], 'DeletePrompt' => [ 'name' => 'DeletePrompt', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prompts/{InstanceId}/{PromptId}', ], 'input' => [ 'shape' => 'DeletePromptRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteQueue' => [ 'name' => 'DeleteQueue', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/queues/{InstanceId}/{QueueId}', ], 'input' => [ 'shape' => 'DeleteQueueRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteQuickConnect' => [ 'name' => 'DeleteQuickConnect', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/quick-connects/{InstanceId}/{QuickConnectId}', ], 'input' => [ 'shape' => 'DeleteQuickConnectRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteRoutingProfile' => [ 'name' => 'DeleteRoutingProfile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}', ], 'input' => [ 'shape' => 'DeleteRoutingProfileRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteRule' => [ 'name' => 'DeleteRule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/rules/{InstanceId}/{RuleId}', ], 'input' => [ 'shape' => 'DeleteRuleRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteSecurityProfile' => [ 'name' => 'DeleteSecurityProfile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/security-profiles/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'DeleteSecurityProfileRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteTaskTemplate' => [ 'name' => 'DeleteTaskTemplate', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/task/template/{TaskTemplateId}', ], 'input' => [ 'shape' => 'DeleteTaskTemplateRequest', ], 'output' => [ 'shape' => 'DeleteTaskTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteTrafficDistributionGroup' => [ 'name' => 'DeleteTrafficDistributionGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}', ], 'input' => [ 'shape' => 'DeleteTrafficDistributionGroupRequest', ], 'output' => [ 'shape' => 'DeleteTrafficDistributionGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteUseCase' => [ 'name' => 'DeleteUseCase', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}', ], 'input' => [ 'shape' => 'DeleteUseCaseRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/users/{InstanceId}/{UserId}', ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteUserHierarchyGroup' => [ 'name' => 'DeleteUserHierarchyGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}', ], 'input' => [ 'shape' => 'DeleteUserHierarchyGroupRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteView' => [ 'name' => 'DeleteView', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/views/{InstanceId}/{ViewId}', ], 'input' => [ 'shape' => 'DeleteViewRequest', ], 'output' => [ 'shape' => 'DeleteViewResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteViewVersion' => [ 'name' => 'DeleteViewVersion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/views/{InstanceId}/{ViewId}/versions/{ViewVersion}', ], 'input' => [ 'shape' => 'DeleteViewVersionRequest', ], 'output' => [ 'shape' => 'DeleteViewVersionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteVocabulary' => [ 'name' => 'DeleteVocabulary', 'http' => [ 'method' => 'POST', 'requestUri' => '/vocabulary-remove/{InstanceId}/{VocabularyId}', ], 'input' => [ 'shape' => 'DeleteVocabularyRequest', ], 'output' => [ 'shape' => 'DeleteVocabularyResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DescribeAgentStatus' => [ 'name' => 'DescribeAgentStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/agent-status/{InstanceId}/{AgentStatusId}', ], 'input' => [ 'shape' => 'DescribeAgentStatusRequest', ], 'output' => [ 'shape' => 'DescribeAgentStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeContact' => [ 'name' => 'DescribeContact', 'http' => [ 'method' => 'GET', 'requestUri' => '/contacts/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'DescribeContactRequest', ], 'output' => [ 'shape' => 'DescribeContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DescribeContactEvaluation' => [ 'name' => 'DescribeContactEvaluation', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-evaluations/{InstanceId}/{EvaluationId}', ], 'input' => [ 'shape' => 'DescribeContactEvaluationRequest', ], 'output' => [ 'shape' => 'DescribeContactEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeContactFlow' => [ 'name' => 'DescribeContactFlow', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}', ], 'input' => [ 'shape' => 'DescribeContactFlowRequest', ], 'output' => [ 'shape' => 'DescribeContactFlowResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ContactFlowNotPublishedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeContactFlowModule' => [ 'name' => 'DescribeContactFlowModule', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}', ], 'input' => [ 'shape' => 'DescribeContactFlowModuleRequest', ], 'output' => [ 'shape' => 'DescribeContactFlowModuleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeEvaluationForm' => [ 'name' => 'DescribeEvaluationForm', 'http' => [ 'method' => 'GET', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}', ], 'input' => [ 'shape' => 'DescribeEvaluationFormRequest', ], 'output' => [ 'shape' => 'DescribeEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeHoursOfOperation' => [ 'name' => 'DescribeHoursOfOperation', 'http' => [ 'method' => 'GET', 'requestUri' => '/hours-of-operations/{InstanceId}/{HoursOfOperationId}', ], 'input' => [ 'shape' => 'DescribeHoursOfOperationRequest', ], 'output' => [ 'shape' => 'DescribeHoursOfOperationResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeInstance' => [ 'name' => 'DescribeInstance', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}', ], 'input' => [ 'shape' => 'DescribeInstanceRequest', ], 'output' => [ 'shape' => 'DescribeInstanceResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeInstanceAttribute' => [ 'name' => 'DescribeInstanceAttribute', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/attribute/{AttributeType}', ], 'input' => [ 'shape' => 'DescribeInstanceAttributeRequest', ], 'output' => [ 'shape' => 'DescribeInstanceAttributeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DescribeInstanceStorageConfig' => [ 'name' => 'DescribeInstanceStorageConfig', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/storage-config/{AssociationId}', ], 'input' => [ 'shape' => 'DescribeInstanceStorageConfigRequest', ], 'output' => [ 'shape' => 'DescribeInstanceStorageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DescribePhoneNumber' => [ 'name' => 'DescribePhoneNumber', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-number/{PhoneNumberId}', ], 'input' => [ 'shape' => 'DescribePhoneNumberRequest', ], 'output' => [ 'shape' => 'DescribePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribePredefinedAttribute' => [ 'name' => 'DescribePredefinedAttribute', 'http' => [ 'method' => 'GET', 'requestUri' => '/predefined-attributes/{InstanceId}/{Name}', ], 'input' => [ 'shape' => 'DescribePredefinedAttributeRequest', ], 'output' => [ 'shape' => 'DescribePredefinedAttributeResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribePrompt' => [ 'name' => 'DescribePrompt', 'http' => [ 'method' => 'GET', 'requestUri' => '/prompts/{InstanceId}/{PromptId}', ], 'input' => [ 'shape' => 'DescribePromptRequest', ], 'output' => [ 'shape' => 'DescribePromptResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeQueue' => [ 'name' => 'DescribeQueue', 'http' => [ 'method' => 'GET', 'requestUri' => '/queues/{InstanceId}/{QueueId}', ], 'input' => [ 'shape' => 'DescribeQueueRequest', ], 'output' => [ 'shape' => 'DescribeQueueResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeQuickConnect' => [ 'name' => 'DescribeQuickConnect', 'http' => [ 'method' => 'GET', 'requestUri' => '/quick-connects/{InstanceId}/{QuickConnectId}', ], 'input' => [ 'shape' => 'DescribeQuickConnectRequest', ], 'output' => [ 'shape' => 'DescribeQuickConnectResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeRoutingProfile' => [ 'name' => 'DescribeRoutingProfile', 'http' => [ 'method' => 'GET', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}', ], 'input' => [ 'shape' => 'DescribeRoutingProfileRequest', ], 'output' => [ 'shape' => 'DescribeRoutingProfileResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeRule' => [ 'name' => 'DescribeRule', 'http' => [ 'method' => 'GET', 'requestUri' => '/rules/{InstanceId}/{RuleId}', ], 'input' => [ 'shape' => 'DescribeRuleRequest', ], 'output' => [ 'shape' => 'DescribeRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeSecurityProfile' => [ 'name' => 'DescribeSecurityProfile', 'http' => [ 'method' => 'GET', 'requestUri' => '/security-profiles/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'DescribeSecurityProfileRequest', ], 'output' => [ 'shape' => 'DescribeSecurityProfileResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeTrafficDistributionGroup' => [ 'name' => 'DescribeTrafficDistributionGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}', ], 'input' => [ 'shape' => 'DescribeTrafficDistributionGroupRequest', ], 'output' => [ 'shape' => 'DescribeTrafficDistributionGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DescribeUser' => [ 'name' => 'DescribeUser', 'http' => [ 'method' => 'GET', 'requestUri' => '/users/{InstanceId}/{UserId}', ], 'input' => [ 'shape' => 'DescribeUserRequest', ], 'output' => [ 'shape' => 'DescribeUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeUserHierarchyGroup' => [ 'name' => 'DescribeUserHierarchyGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}', ], 'input' => [ 'shape' => 'DescribeUserHierarchyGroupRequest', ], 'output' => [ 'shape' => 'DescribeUserHierarchyGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeUserHierarchyStructure' => [ 'name' => 'DescribeUserHierarchyStructure', 'http' => [ 'method' => 'GET', 'requestUri' => '/user-hierarchy-structure/{InstanceId}', ], 'input' => [ 'shape' => 'DescribeUserHierarchyStructureRequest', ], 'output' => [ 'shape' => 'DescribeUserHierarchyStructureResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeView' => [ 'name' => 'DescribeView', 'http' => [ 'method' => 'GET', 'requestUri' => '/views/{InstanceId}/{ViewId}', ], 'input' => [ 'shape' => 'DescribeViewRequest', ], 'output' => [ 'shape' => 'DescribeViewResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeVocabulary' => [ 'name' => 'DescribeVocabulary', 'http' => [ 'method' => 'GET', 'requestUri' => '/vocabulary/{InstanceId}/{VocabularyId}', ], 'input' => [ 'shape' => 'DescribeVocabularyRequest', ], 'output' => [ 'shape' => 'DescribeVocabularyResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DisassociateAnalyticsDataSet' => [ 'name' => 'DisassociateAnalyticsDataSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/analytics-data/instance/{InstanceId}/association', ], 'input' => [ 'shape' => 'DisassociateAnalyticsDataSetRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DisassociateApprovedOrigin' => [ 'name' => 'DisassociateApprovedOrigin', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/approved-origin', ], 'input' => [ 'shape' => 'DisassociateApprovedOriginRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateBot' => [ 'name' => 'DisassociateBot', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/bot', ], 'input' => [ 'shape' => 'DisassociateBotRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateFlow' => [ 'name' => 'DisassociateFlow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}', ], 'input' => [ 'shape' => 'DisassociateFlowRequest', ], 'output' => [ 'shape' => 'DisassociateFlowResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateInstanceStorageConfig' => [ 'name' => 'DisassociateInstanceStorageConfig', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/storage-config/{AssociationId}', ], 'input' => [ 'shape' => 'DisassociateInstanceStorageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateLambdaFunction' => [ 'name' => 'DisassociateLambdaFunction', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/lambda-function', ], 'input' => [ 'shape' => 'DisassociateLambdaFunctionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateLexBot' => [ 'name' => 'DisassociateLexBot', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/lex-bot', ], 'input' => [ 'shape' => 'DisassociateLexBotRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociatePhoneNumberContactFlow' => [ 'name' => 'DisassociatePhoneNumberContactFlow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/phone-number/{PhoneNumberId}/contact-flow', ], 'input' => [ 'shape' => 'DisassociatePhoneNumberContactFlowRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DisassociateQueueQuickConnects' => [ 'name' => 'DisassociateQueueQuickConnects', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/disassociate-quick-connects', ], 'input' => [ 'shape' => 'DisassociateQueueQuickConnectsRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DisassociateRoutingProfileQueues' => [ 'name' => 'DisassociateRoutingProfileQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues', ], 'input' => [ 'shape' => 'DisassociateRoutingProfileQueuesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DisassociateSecurityKey' => [ 'name' => 'DisassociateSecurityKey', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/security-key/{AssociationId}', ], 'input' => [ 'shape' => 'DisassociateSecurityKeyRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateTrafficDistributionGroupUser' => [ 'name' => 'DisassociateTrafficDistributionGroupUser', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}/user', ], 'input' => [ 'shape' => 'DisassociateTrafficDistributionGroupUserRequest', ], 'output' => [ 'shape' => 'DisassociateTrafficDistributionGroupUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], ], 'idempotent' => true, ], 'DisassociateUserProficiencies' => [ 'name' => 'DisassociateUserProficiencies', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/disassociate-proficiencies', ], 'input' => [ 'shape' => 'DisassociateUserProficienciesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DismissUserContact' => [ 'name' => 'DismissUserContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/contact', ], 'input' => [ 'shape' => 'DismissUserContactRequest', ], 'output' => [ 'shape' => 'DismissUserContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetAttachedFile' => [ 'name' => 'GetAttachedFile', 'http' => [ 'method' => 'GET', 'requestUri' => '/attached-files/{InstanceId}/{FileId}', ], 'input' => [ 'shape' => 'GetAttachedFileRequest', ], 'output' => [ 'shape' => 'GetAttachedFileResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetContactAttributes' => [ 'name' => 'GetContactAttributes', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact/attributes/{InstanceId}/{InitialContactId}', ], 'input' => [ 'shape' => 'GetContactAttributesRequest', ], 'output' => [ 'shape' => 'GetContactAttributesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetCurrentMetricData' => [ 'name' => 'GetCurrentMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/metrics/current/{InstanceId}', ], 'input' => [ 'shape' => 'GetCurrentMetricDataRequest', ], 'output' => [ 'shape' => 'GetCurrentMetricDataResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetCurrentUserData' => [ 'name' => 'GetCurrentUserData', 'http' => [ 'method' => 'POST', 'requestUri' => '/metrics/userdata/{InstanceId}', ], 'input' => [ 'shape' => 'GetCurrentUserDataRequest', ], 'output' => [ 'shape' => 'GetCurrentUserDataResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetFederationToken' => [ 'name' => 'GetFederationToken', 'http' => [ 'method' => 'GET', 'requestUri' => '/user/federate/{InstanceId}', ], 'input' => [ 'shape' => 'GetFederationTokenRequest', ], 'output' => [ 'shape' => 'GetFederationTokenResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'DuplicateResourceException', ], ], ], 'GetFlowAssociation' => [ 'name' => 'GetFlowAssociation', 'http' => [ 'method' => 'GET', 'requestUri' => '/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}', ], 'input' => [ 'shape' => 'GetFlowAssociationRequest', ], 'output' => [ 'shape' => 'GetFlowAssociationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetMetricData' => [ 'name' => 'GetMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/metrics/historical/{InstanceId}', ], 'input' => [ 'shape' => 'GetMetricDataRequest', ], 'output' => [ 'shape' => 'GetMetricDataResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetMetricDataV2' => [ 'name' => 'GetMetricDataV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/metrics/data', ], 'input' => [ 'shape' => 'GetMetricDataV2Request', ], 'output' => [ 'shape' => 'GetMetricDataV2Response', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetPromptFile' => [ 'name' => 'GetPromptFile', 'http' => [ 'method' => 'GET', 'requestUri' => '/prompts/{InstanceId}/{PromptId}/file', ], 'input' => [ 'shape' => 'GetPromptFileRequest', ], 'output' => [ 'shape' => 'GetPromptFileResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetTaskTemplate' => [ 'name' => 'GetTaskTemplate', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/task/template/{TaskTemplateId}', ], 'input' => [ 'shape' => 'GetTaskTemplateRequest', ], 'output' => [ 'shape' => 'GetTaskTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetTrafficDistribution' => [ 'name' => 'GetTrafficDistribution', 'http' => [ 'method' => 'GET', 'requestUri' => '/traffic-distribution/{Id}', ], 'input' => [ 'shape' => 'GetTrafficDistributionRequest', ], 'output' => [ 'shape' => 'GetTrafficDistributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ImportPhoneNumber' => [ 'name' => 'ImportPhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number/import', ], 'input' => [ 'shape' => 'ImportPhoneNumberRequest', ], 'output' => [ 'shape' => 'ImportPhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAgentStatuses' => [ 'name' => 'ListAgentStatuses', 'http' => [ 'method' => 'GET', 'requestUri' => '/agent-status/{InstanceId}', ], 'input' => [ 'shape' => 'ListAgentStatusRequest', ], 'output' => [ 'shape' => 'ListAgentStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListAnalyticsDataAssociations' => [ 'name' => 'ListAnalyticsDataAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/analytics-data/instance/{InstanceId}/association', ], 'input' => [ 'shape' => 'ListAnalyticsDataAssociationsRequest', ], 'output' => [ 'shape' => 'ListAnalyticsDataAssociationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListApprovedOrigins' => [ 'name' => 'ListApprovedOrigins', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/approved-origins', ], 'input' => [ 'shape' => 'ListApprovedOriginsRequest', ], 'output' => [ 'shape' => 'ListApprovedOriginsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListBots' => [ 'name' => 'ListBots', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/bots', ], 'input' => [ 'shape' => 'ListBotsRequest', ], 'output' => [ 'shape' => 'ListBotsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListContactEvaluations' => [ 'name' => 'ListContactEvaluations', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-evaluations/{InstanceId}', ], 'input' => [ 'shape' => 'ListContactEvaluationsRequest', ], 'output' => [ 'shape' => 'ListContactEvaluationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListContactFlowModules' => [ 'name' => 'ListContactFlowModules', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-flow-modules-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListContactFlowModulesRequest', ], 'output' => [ 'shape' => 'ListContactFlowModulesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListContactFlows' => [ 'name' => 'ListContactFlows', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-flows-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListContactFlowsRequest', ], 'output' => [ 'shape' => 'ListContactFlowsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListContactReferences' => [ 'name' => 'ListContactReferences', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact/references/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'ListContactReferencesRequest', ], 'output' => [ 'shape' => 'ListContactReferencesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListDefaultVocabularies' => [ 'name' => 'ListDefaultVocabularies', 'http' => [ 'method' => 'POST', 'requestUri' => '/default-vocabulary-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListDefaultVocabulariesRequest', ], 'output' => [ 'shape' => 'ListDefaultVocabulariesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListEvaluationFormVersions' => [ 'name' => 'ListEvaluationFormVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}/versions', ], 'input' => [ 'shape' => 'ListEvaluationFormVersionsRequest', ], 'output' => [ 'shape' => 'ListEvaluationFormVersionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListEvaluationForms' => [ 'name' => 'ListEvaluationForms', 'http' => [ 'method' => 'GET', 'requestUri' => '/evaluation-forms/{InstanceId}', ], 'input' => [ 'shape' => 'ListEvaluationFormsRequest', ], 'output' => [ 'shape' => 'ListEvaluationFormsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListFlowAssociations' => [ 'name' => 'ListFlowAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/flow-associations-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListFlowAssociationsRequest', ], 'output' => [ 'shape' => 'ListFlowAssociationsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListHoursOfOperations' => [ 'name' => 'ListHoursOfOperations', 'http' => [ 'method' => 'GET', 'requestUri' => '/hours-of-operations-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListHoursOfOperationsRequest', ], 'output' => [ 'shape' => 'ListHoursOfOperationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListInstanceAttributes' => [ 'name' => 'ListInstanceAttributes', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/attributes', ], 'input' => [ 'shape' => 'ListInstanceAttributesRequest', ], 'output' => [ 'shape' => 'ListInstanceAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListInstanceStorageConfigs' => [ 'name' => 'ListInstanceStorageConfigs', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/storage-configs', ], 'input' => [ 'shape' => 'ListInstanceStorageConfigsRequest', ], 'output' => [ 'shape' => 'ListInstanceStorageConfigsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListInstances' => [ 'name' => 'ListInstances', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance', ], 'input' => [ 'shape' => 'ListInstancesRequest', ], 'output' => [ 'shape' => 'ListInstancesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListIntegrationAssociations' => [ 'name' => 'ListIntegrationAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/integration-associations', ], 'input' => [ 'shape' => 'ListIntegrationAssociationsRequest', ], 'output' => [ 'shape' => 'ListIntegrationAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListLambdaFunctions' => [ 'name' => 'ListLambdaFunctions', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/lambda-functions', ], 'input' => [ 'shape' => 'ListLambdaFunctionsRequest', ], 'output' => [ 'shape' => 'ListLambdaFunctionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListLexBots' => [ 'name' => 'ListLexBots', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/lex-bots', ], 'input' => [ 'shape' => 'ListLexBotsRequest', ], 'output' => [ 'shape' => 'ListLexBotsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListPhoneNumbers' => [ 'name' => 'ListPhoneNumbers', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-numbers-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListPhoneNumbersRequest', ], 'output' => [ 'shape' => 'ListPhoneNumbersResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListPhoneNumbersV2' => [ 'name' => 'ListPhoneNumbersV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number/list', ], 'input' => [ 'shape' => 'ListPhoneNumbersV2Request', ], 'output' => [ 'shape' => 'ListPhoneNumbersV2Response', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListPredefinedAttributes' => [ 'name' => 'ListPredefinedAttributes', 'http' => [ 'method' => 'GET', 'requestUri' => '/predefined-attributes/{InstanceId}', ], 'input' => [ 'shape' => 'ListPredefinedAttributesRequest', ], 'output' => [ 'shape' => 'ListPredefinedAttributesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListPrompts' => [ 'name' => 'ListPrompts', 'http' => [ 'method' => 'GET', 'requestUri' => '/prompts-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListPromptsRequest', ], 'output' => [ 'shape' => 'ListPromptsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListQueueQuickConnects' => [ 'name' => 'ListQueueQuickConnects', 'http' => [ 'method' => 'GET', 'requestUri' => '/queues/{InstanceId}/{QueueId}/quick-connects', ], 'input' => [ 'shape' => 'ListQueueQuickConnectsRequest', ], 'output' => [ 'shape' => 'ListQueueQuickConnectsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListQueues' => [ 'name' => 'ListQueues', 'http' => [ 'method' => 'GET', 'requestUri' => '/queues-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListQueuesRequest', ], 'output' => [ 'shape' => 'ListQueuesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListQuickConnects' => [ 'name' => 'ListQuickConnects', 'http' => [ 'method' => 'GET', 'requestUri' => '/quick-connects/{InstanceId}', ], 'input' => [ 'shape' => 'ListQuickConnectsRequest', ], 'output' => [ 'shape' => 'ListQuickConnectsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListRealtimeContactAnalysisSegmentsV2' => [ 'name' => 'ListRealtimeContactAnalysisSegmentsV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'ListRealtimeContactAnalysisSegmentsV2Request', ], 'output' => [ 'shape' => 'ListRealtimeContactAnalysisSegmentsV2Response', ], 'errors' => [ [ 'shape' => 'OutputTypeNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListRoutingProfileQueues' => [ 'name' => 'ListRoutingProfileQueues', 'http' => [ 'method' => 'GET', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/queues', ], 'input' => [ 'shape' => 'ListRoutingProfileQueuesRequest', ], 'output' => [ 'shape' => 'ListRoutingProfileQueuesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListRoutingProfiles' => [ 'name' => 'ListRoutingProfiles', 'http' => [ 'method' => 'GET', 'requestUri' => '/routing-profiles-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListRoutingProfilesRequest', ], 'output' => [ 'shape' => 'ListRoutingProfilesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListRules' => [ 'name' => 'ListRules', 'http' => [ 'method' => 'GET', 'requestUri' => '/rules/{InstanceId}', ], 'input' => [ 'shape' => 'ListRulesRequest', ], 'output' => [ 'shape' => 'ListRulesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListSecurityKeys' => [ 'name' => 'ListSecurityKeys', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/security-keys', ], 'input' => [ 'shape' => 'ListSecurityKeysRequest', ], 'output' => [ 'shape' => 'ListSecurityKeysResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListSecurityProfileApplications' => [ 'name' => 'ListSecurityProfileApplications', 'http' => [ 'method' => 'GET', 'requestUri' => '/security-profiles-applications/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'ListSecurityProfileApplicationsRequest', ], 'output' => [ 'shape' => 'ListSecurityProfileApplicationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListSecurityProfilePermissions' => [ 'name' => 'ListSecurityProfilePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/security-profiles-permissions/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'ListSecurityProfilePermissionsRequest', ], 'output' => [ 'shape' => 'ListSecurityProfilePermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListSecurityProfiles' => [ 'name' => 'ListSecurityProfiles', 'http' => [ 'method' => 'GET', 'requestUri' => '/security-profiles-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListSecurityProfilesRequest', ], 'output' => [ 'shape' => 'ListSecurityProfilesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListTaskTemplates' => [ 'name' => 'ListTaskTemplates', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/task/template', ], 'input' => [ 'shape' => 'ListTaskTemplatesRequest', ], 'output' => [ 'shape' => 'ListTaskTemplatesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListTrafficDistributionGroupUsers' => [ 'name' => 'ListTrafficDistributionGroupUsers', 'http' => [ 'method' => 'GET', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}/user', ], 'input' => [ 'shape' => 'ListTrafficDistributionGroupUsersRequest', ], 'output' => [ 'shape' => 'ListTrafficDistributionGroupUsersResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListTrafficDistributionGroups' => [ 'name' => 'ListTrafficDistributionGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/traffic-distribution-groups', ], 'input' => [ 'shape' => 'ListTrafficDistributionGroupsRequest', ], 'output' => [ 'shape' => 'ListTrafficDistributionGroupsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListUseCases' => [ 'name' => 'ListUseCases', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases', ], 'input' => [ 'shape' => 'ListUseCasesRequest', ], 'output' => [ 'shape' => 'ListUseCasesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListUserHierarchyGroups' => [ 'name' => 'ListUserHierarchyGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/user-hierarchy-groups-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListUserHierarchyGroupsRequest', ], 'output' => [ 'shape' => 'ListUserHierarchyGroupsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListUserProficiencies' => [ 'name' => 'ListUserProficiencies', 'http' => [ 'method' => 'GET', 'requestUri' => '/users/{InstanceId}/{UserId}/proficiencies', ], 'input' => [ 'shape' => 'ListUserProficienciesRequest', ], 'output' => [ 'shape' => 'ListUserProficienciesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListUsers' => [ 'name' => 'ListUsers', 'http' => [ 'method' => 'GET', 'requestUri' => '/users-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListUsersRequest', ], 'output' => [ 'shape' => 'ListUsersResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListViewVersions' => [ 'name' => 'ListViewVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/views/{InstanceId}/{ViewId}/versions', ], 'input' => [ 'shape' => 'ListViewVersionsRequest', ], 'output' => [ 'shape' => 'ListViewVersionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListViews' => [ 'name' => 'ListViews', 'http' => [ 'method' => 'GET', 'requestUri' => '/views/{InstanceId}', ], 'input' => [ 'shape' => 'ListViewsRequest', ], 'output' => [ 'shape' => 'ListViewsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'MonitorContact' => [ 'name' => 'MonitorContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/monitor', ], 'input' => [ 'shape' => 'MonitorContactRequest', ], 'output' => [ 'shape' => 'MonitorContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'PauseContact' => [ 'name' => 'PauseContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/pause', ], 'input' => [ 'shape' => 'PauseContactRequest', ], 'output' => [ 'shape' => 'PauseContactResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], ], ], 'PutUserStatus' => [ 'name' => 'PutUserStatus', 'http' => [ 'method' => 'PUT', 'requestUri' => '/users/{InstanceId}/{UserId}/status', ], 'input' => [ 'shape' => 'PutUserStatusRequest', ], 'output' => [ 'shape' => 'PutUserStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ReleasePhoneNumber' => [ 'name' => 'ReleasePhoneNumber', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/phone-number/{PhoneNumberId}', ], 'input' => [ 'shape' => 'ReleasePhoneNumberRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ReplicateInstance' => [ 'name' => 'ReplicateInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/replicate', ], 'input' => [ 'shape' => 'ReplicateInstanceRequest', ], 'output' => [ 'shape' => 'ReplicateInstanceResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotReadyException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'ResumeContact' => [ 'name' => 'ResumeContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/resume', ], 'input' => [ 'shape' => 'ResumeContactRequest', ], 'output' => [ 'shape' => 'ResumeContactResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], ], ], 'ResumeContactRecording' => [ 'name' => 'ResumeContactRecording', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/resume-recording', ], 'input' => [ 'shape' => 'ResumeContactRecordingRequest', ], 'output' => [ 'shape' => 'ResumeContactRecordingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchAvailablePhoneNumbers' => [ 'name' => 'SearchAvailablePhoneNumbers', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number/search-available', ], 'input' => [ 'shape' => 'SearchAvailablePhoneNumbersRequest', ], 'output' => [ 'shape' => 'SearchAvailablePhoneNumbersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'SearchContactFlowModules' => [ 'name' => 'SearchContactFlowModules', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-contact-flow-modules', ], 'input' => [ 'shape' => 'SearchContactFlowModulesRequest', ], 'output' => [ 'shape' => 'SearchContactFlowModulesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchContactFlows' => [ 'name' => 'SearchContactFlows', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-contact-flows', ], 'input' => [ 'shape' => 'SearchContactFlowsRequest', ], 'output' => [ 'shape' => 'SearchContactFlowsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchContacts' => [ 'name' => 'SearchContacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-contacts', ], 'input' => [ 'shape' => 'SearchContactsRequest', ], 'output' => [ 'shape' => 'SearchContactsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'SearchHoursOfOperations' => [ 'name' => 'SearchHoursOfOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-hours-of-operations', ], 'input' => [ 'shape' => 'SearchHoursOfOperationsRequest', ], 'output' => [ 'shape' => 'SearchHoursOfOperationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchPredefinedAttributes' => [ 'name' => 'SearchPredefinedAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-predefined-attributes', ], 'input' => [ 'shape' => 'SearchPredefinedAttributesRequest', ], 'output' => [ 'shape' => 'SearchPredefinedAttributesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchPrompts' => [ 'name' => 'SearchPrompts', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-prompts', ], 'input' => [ 'shape' => 'SearchPromptsRequest', ], 'output' => [ 'shape' => 'SearchPromptsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchQueues' => [ 'name' => 'SearchQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-queues', ], 'input' => [ 'shape' => 'SearchQueuesRequest', ], 'output' => [ 'shape' => 'SearchQueuesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchQuickConnects' => [ 'name' => 'SearchQuickConnects', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-quick-connects', ], 'input' => [ 'shape' => 'SearchQuickConnectsRequest', ], 'output' => [ 'shape' => 'SearchQuickConnectsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchResourceTags' => [ 'name' => 'SearchResourceTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-resource-tags', ], 'input' => [ 'shape' => 'SearchResourceTagsRequest', ], 'output' => [ 'shape' => 'SearchResourceTagsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'MaximumResultReturnedException', ], ], ], 'SearchRoutingProfiles' => [ 'name' => 'SearchRoutingProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-routing-profiles', ], 'input' => [ 'shape' => 'SearchRoutingProfilesRequest', ], 'output' => [ 'shape' => 'SearchRoutingProfilesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchSecurityProfiles' => [ 'name' => 'SearchSecurityProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-security-profiles', ], 'input' => [ 'shape' => 'SearchSecurityProfilesRequest', ], 'output' => [ 'shape' => 'SearchSecurityProfilesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchUsers' => [ 'name' => 'SearchUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-users', ], 'input' => [ 'shape' => 'SearchUsersRequest', ], 'output' => [ 'shape' => 'SearchUsersResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchVocabularies' => [ 'name' => 'SearchVocabularies', 'http' => [ 'method' => 'POST', 'requestUri' => '/vocabulary-summary/{InstanceId}', ], 'input' => [ 'shape' => 'SearchVocabulariesRequest', ], 'output' => [ 'shape' => 'SearchVocabulariesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'SendChatIntegrationEvent' => [ 'name' => 'SendChatIntegrationEvent', 'http' => [ 'method' => 'POST', 'requestUri' => '/chat-integration-event', ], 'input' => [ 'shape' => 'SendChatIntegrationEventRequest', ], 'output' => [ 'shape' => 'SendChatIntegrationEventResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'StartAttachedFileUpload' => [ 'name' => 'StartAttachedFileUpload', 'http' => [ 'method' => 'PUT', 'requestUri' => '/attached-files/{InstanceId}', ], 'input' => [ 'shape' => 'StartAttachedFileUploadRequest', ], 'output' => [ 'shape' => 'StartAttachedFileUploadResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'StartChatContact' => [ 'name' => 'StartChatContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/chat', ], 'input' => [ 'shape' => 'StartChatContactRequest', ], 'output' => [ 'shape' => 'StartChatContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'StartContactEvaluation' => [ 'name' => 'StartContactEvaluation', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact-evaluations/{InstanceId}', ], 'input' => [ 'shape' => 'StartContactEvaluationRequest', ], 'output' => [ 'shape' => 'StartContactEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'StartContactRecording' => [ 'name' => 'StartContactRecording', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/start-recording', ], 'input' => [ 'shape' => 'StartContactRecordingRequest', ], 'output' => [ 'shape' => 'StartContactRecordingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'StartContactStreaming' => [ 'name' => 'StartContactStreaming', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/start-streaming', ], 'input' => [ 'shape' => 'StartContactStreamingRequest', ], 'output' => [ 'shape' => 'StartContactStreamingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'StartOutboundVoiceContact' => [ 'name' => 'StartOutboundVoiceContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/outbound-voice', ], 'input' => [ 'shape' => 'StartOutboundVoiceContactRequest', ], 'output' => [ 'shape' => 'StartOutboundVoiceContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DestinationNotAllowedException', ], [ 'shape' => 'OutboundContactNotPermittedException', ], ], ], 'StartTaskContact' => [ 'name' => 'StartTaskContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/task', ], 'input' => [ 'shape' => 'StartTaskContactRequest', ], 'output' => [ 'shape' => 'StartTaskContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'StartWebRTCContact' => [ 'name' => 'StartWebRTCContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/webrtc', ], 'input' => [ 'shape' => 'StartWebRTCContactRequest', ], 'output' => [ 'shape' => 'StartWebRTCContactResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'StopContact' => [ 'name' => 'StopContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/stop', ], 'input' => [ 'shape' => 'StopContactRequest', ], 'output' => [ 'shape' => 'StopContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ContactNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'StopContactRecording' => [ 'name' => 'StopContactRecording', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/stop-recording', ], 'input' => [ 'shape' => 'StopContactRecordingRequest', ], 'output' => [ 'shape' => 'StopContactRecordingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'StopContactStreaming' => [ 'name' => 'StopContactStreaming', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/stop-streaming', ], 'input' => [ 'shape' => 'StopContactStreamingRequest', ], 'output' => [ 'shape' => 'StopContactStreamingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SubmitContactEvaluation' => [ 'name' => 'SubmitContactEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-evaluations/{InstanceId}/{EvaluationId}/submit', ], 'input' => [ 'shape' => 'SubmitContactEvaluationRequest', ], 'output' => [ 'shape' => 'SubmitContactEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'SuspendContactRecording' => [ 'name' => 'SuspendContactRecording', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/suspend-recording', ], 'input' => [ 'shape' => 'SuspendContactRecordingRequest', ], 'output' => [ 'shape' => 'SuspendContactRecordingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'TagContact' => [ 'name' => 'TagContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/tags', ], 'input' => [ 'shape' => 'TagContactRequest', ], 'output' => [ 'shape' => 'TagContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], 'idempotent' => true, ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'TransferContact' => [ 'name' => 'TransferContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/transfer', ], 'input' => [ 'shape' => 'TransferContactRequest', ], 'output' => [ 'shape' => 'TransferContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UntagContact' => [ 'name' => 'UntagContact', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/contact/tags/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'UntagContactRequest', ], 'output' => [ 'shape' => 'UntagContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], 'idempotent' => true, ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateAgentStatus' => [ 'name' => 'UpdateAgentStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/agent-status/{InstanceId}/{AgentStatusId}', ], 'input' => [ 'shape' => 'UpdateAgentStatusRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContact' => [ 'name' => 'UpdateContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contacts/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'UpdateContactRequest', ], 'output' => [ 'shape' => 'UpdateContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateContactAttributes' => [ 'name' => 'UpdateContactAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/attributes', ], 'input' => [ 'shape' => 'UpdateContactAttributesRequest', ], 'output' => [ 'shape' => 'UpdateContactAttributesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactEvaluation' => [ 'name' => 'UpdateContactEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-evaluations/{InstanceId}/{EvaluationId}', ], 'input' => [ 'shape' => 'UpdateContactEvaluationRequest', ], 'output' => [ 'shape' => 'UpdateContactEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'UpdateContactFlowContent' => [ 'name' => 'UpdateContactFlowContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}/content', ], 'input' => [ 'shape' => 'UpdateContactFlowContentRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowContentResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidContactFlowException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactFlowMetadata' => [ 'name' => 'UpdateContactFlowMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}/metadata', ], 'input' => [ 'shape' => 'UpdateContactFlowMetadataRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowMetadataResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactFlowModuleContent' => [ 'name' => 'UpdateContactFlowModuleContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content', ], 'input' => [ 'shape' => 'UpdateContactFlowModuleContentRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowModuleContentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidContactFlowModuleException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactFlowModuleMetadata' => [ 'name' => 'UpdateContactFlowModuleMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata', ], 'input' => [ 'shape' => 'UpdateContactFlowModuleMetadataRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowModuleMetadataResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactFlowName' => [ 'name' => 'UpdateContactFlowName', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}/name', ], 'input' => [ 'shape' => 'UpdateContactFlowNameRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowNameResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactRoutingData' => [ 'name' => 'UpdateContactRoutingData', 'http' => [ 'method' => 'POST', 'requestUri' => '/contacts/{InstanceId}/{ContactId}/routing-data', ], 'input' => [ 'shape' => 'UpdateContactRoutingDataRequest', ], 'output' => [ 'shape' => 'UpdateContactRoutingDataResponse', ], 'errors' => [ [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateContactSchedule' => [ 'name' => 'UpdateContactSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/schedule', ], 'input' => [ 'shape' => 'UpdateContactScheduleRequest', ], 'output' => [ 'shape' => 'UpdateContactScheduleResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateEvaluationForm' => [ 'name' => 'UpdateEvaluationForm', 'http' => [ 'method' => 'PUT', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}', ], 'input' => [ 'shape' => 'UpdateEvaluationFormRequest', ], 'output' => [ 'shape' => 'UpdateEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'UpdateHoursOfOperation' => [ 'name' => 'UpdateHoursOfOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/hours-of-operations/{InstanceId}/{HoursOfOperationId}', ], 'input' => [ 'shape' => 'UpdateHoursOfOperationRequest', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateInstanceAttribute' => [ 'name' => 'UpdateInstanceAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/attribute/{AttributeType}', ], 'input' => [ 'shape' => 'UpdateInstanceAttributeRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateInstanceStorageConfig' => [ 'name' => 'UpdateInstanceStorageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/storage-config/{AssociationId}', ], 'input' => [ 'shape' => 'UpdateInstanceStorageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateParticipantRoleConfig' => [ 'name' => 'UpdateParticipantRoleConfig', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/participant-role-config/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'UpdateParticipantRoleConfigRequest', ], 'output' => [ 'shape' => 'UpdateParticipantRoleConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdatePhoneNumber' => [ 'name' => 'UpdatePhoneNumber', 'http' => [ 'method' => 'PUT', 'requestUri' => '/phone-number/{PhoneNumberId}', ], 'input' => [ 'shape' => 'UpdatePhoneNumberRequest', ], 'output' => [ 'shape' => 'UpdatePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdatePhoneNumberMetadata' => [ 'name' => 'UpdatePhoneNumberMetadata', 'http' => [ 'method' => 'PUT', 'requestUri' => '/phone-number/{PhoneNumberId}/metadata', ], 'input' => [ 'shape' => 'UpdatePhoneNumberMetadataRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdatePredefinedAttribute' => [ 'name' => 'UpdatePredefinedAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/predefined-attributes/{InstanceId}/{Name}', ], 'input' => [ 'shape' => 'UpdatePredefinedAttributeRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdatePrompt' => [ 'name' => 'UpdatePrompt', 'http' => [ 'method' => 'POST', 'requestUri' => '/prompts/{InstanceId}/{PromptId}', ], 'input' => [ 'shape' => 'UpdatePromptRequest', ], 'output' => [ 'shape' => 'UpdatePromptResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueHoursOfOperation' => [ 'name' => 'UpdateQueueHoursOfOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/hours-of-operation', ], 'input' => [ 'shape' => 'UpdateQueueHoursOfOperationRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueMaxContacts' => [ 'name' => 'UpdateQueueMaxContacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/max-contacts', ], 'input' => [ 'shape' => 'UpdateQueueMaxContactsRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueName' => [ 'name' => 'UpdateQueueName', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/name', ], 'input' => [ 'shape' => 'UpdateQueueNameRequest', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueOutboundCallerConfig' => [ 'name' => 'UpdateQueueOutboundCallerConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/outbound-caller-config', ], 'input' => [ 'shape' => 'UpdateQueueOutboundCallerConfigRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueStatus' => [ 'name' => 'UpdateQueueStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/status', ], 'input' => [ 'shape' => 'UpdateQueueStatusRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQuickConnectConfig' => [ 'name' => 'UpdateQuickConnectConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/quick-connects/{InstanceId}/{QuickConnectId}/config', ], 'input' => [ 'shape' => 'UpdateQuickConnectConfigRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQuickConnectName' => [ 'name' => 'UpdateQuickConnectName', 'http' => [ 'method' => 'POST', 'requestUri' => '/quick-connects/{InstanceId}/{QuickConnectId}/name', ], 'input' => [ 'shape' => 'UpdateQuickConnectNameRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileAgentAvailabilityTimer' => [ 'name' => 'UpdateRoutingProfileAgentAvailabilityTimer', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer', ], 'input' => [ 'shape' => 'UpdateRoutingProfileAgentAvailabilityTimerRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileConcurrency' => [ 'name' => 'UpdateRoutingProfileConcurrency', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency', ], 'input' => [ 'shape' => 'UpdateRoutingProfileConcurrencyRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileDefaultOutboundQueue' => [ 'name' => 'UpdateRoutingProfileDefaultOutboundQueue', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue', ], 'input' => [ 'shape' => 'UpdateRoutingProfileDefaultOutboundQueueRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileName' => [ 'name' => 'UpdateRoutingProfileName', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/name', ], 'input' => [ 'shape' => 'UpdateRoutingProfileNameRequest', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileQueues' => [ 'name' => 'UpdateRoutingProfileQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/queues', ], 'input' => [ 'shape' => 'UpdateRoutingProfileQueuesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRule' => [ 'name' => 'UpdateRule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/rules/{InstanceId}/{RuleId}', ], 'input' => [ 'shape' => 'UpdateRuleRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'UpdateSecurityProfile' => [ 'name' => 'UpdateSecurityProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/security-profiles/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'UpdateSecurityProfileRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateTaskTemplate' => [ 'name' => 'UpdateTaskTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/task/template/{TaskTemplateId}', ], 'input' => [ 'shape' => 'UpdateTaskTemplateRequest', ], 'output' => [ 'shape' => 'UpdateTaskTemplateResponse', ], 'errors' => [ [ 'shape' => 'PropertyValidationException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateTrafficDistribution' => [ 'name' => 'UpdateTrafficDistribution', 'http' => [ 'method' => 'PUT', 'requestUri' => '/traffic-distribution/{Id}', ], 'input' => [ 'shape' => 'UpdateTrafficDistributionRequest', ], 'output' => [ 'shape' => 'UpdateTrafficDistributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserHierarchy' => [ 'name' => 'UpdateUserHierarchy', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/hierarchy', ], 'input' => [ 'shape' => 'UpdateUserHierarchyRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserHierarchyGroupName' => [ 'name' => 'UpdateUserHierarchyGroupName', 'http' => [ 'method' => 'POST', 'requestUri' => '/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}/name', ], 'input' => [ 'shape' => 'UpdateUserHierarchyGroupNameRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserHierarchyStructure' => [ 'name' => 'UpdateUserHierarchyStructure', 'http' => [ 'method' => 'POST', 'requestUri' => '/user-hierarchy-structure/{InstanceId}', ], 'input' => [ 'shape' => 'UpdateUserHierarchyStructureRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserIdentityInfo' => [ 'name' => 'UpdateUserIdentityInfo', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/identity-info', ], 'input' => [ 'shape' => 'UpdateUserIdentityInfoRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserPhoneConfig' => [ 'name' => 'UpdateUserPhoneConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/phone-config', ], 'input' => [ 'shape' => 'UpdateUserPhoneConfigRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserProficiencies' => [ 'name' => 'UpdateUserProficiencies', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/proficiencies', ], 'input' => [ 'shape' => 'UpdateUserProficienciesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserRoutingProfile' => [ 'name' => 'UpdateUserRoutingProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/routing-profile', ], 'input' => [ 'shape' => 'UpdateUserRoutingProfileRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserSecurityProfiles' => [ 'name' => 'UpdateUserSecurityProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/security-profiles', ], 'input' => [ 'shape' => 'UpdateUserSecurityProfilesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateViewContent' => [ 'name' => 'UpdateViewContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/views/{InstanceId}/{ViewId}', ], 'input' => [ 'shape' => 'UpdateViewContentRequest', ], 'output' => [ 'shape' => 'UpdateViewContentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'UpdateViewMetadata' => [ 'name' => 'UpdateViewMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/views/{InstanceId}/{ViewId}/metadata', ], 'input' => [ 'shape' => 'UpdateViewMetadataRequest', ], 'output' => [ 'shape' => 'UpdateViewMetadataResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceInUseException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', ], 'AWSAccountId' => [ 'type' => 'string', ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'ActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionSummary', ], ], 'ActionSummary' => [ 'type' => 'structure', 'required' => [ 'ActionType', ], 'members' => [ 'ActionType' => [ 'shape' => 'ActionType', ], ], ], 'ActionType' => [ 'type' => 'string', 'enum' => [ 'CREATE_TASK', 'ASSIGN_CONTACT_CATEGORY', 'GENERATE_EVENTBRIDGE_EVENT', 'SEND_NOTIFICATION', 'CREATE_CASE', 'UPDATE_CASE', 'END_ASSOCIATED_TASKS', 'SUBMIT_AUTO_EVALUATION', ], ], 'ActivateEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', 'EvaluationFormVersion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'ActivateEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', 'EvaluationFormVersion', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'AfterContactWorkTimeLimit' => [ 'type' => 'integer', 'min' => 0, ], 'AgentAvailabilityTimer' => [ 'type' => 'string', 'enum' => [ 'TIME_SINCE_LAST_ACTIVITY', 'TIME_SINCE_LAST_INBOUND', ], ], 'AgentConfig' => [ 'type' => 'structure', 'required' => [ 'Distributions', ], 'members' => [ 'Distributions' => [ 'shape' => 'DistributionList', ], ], ], 'AgentContactReference' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'Channel' => [ 'shape' => 'Channel', ], 'InitiationMethod' => [ 'shape' => 'ContactInitiationMethod', ], 'AgentContactState' => [ 'shape' => 'ContactState', ], 'StateStartTimestamp' => [ 'shape' => 'Timestamp', ], 'ConnectedToAgentTimestamp' => [ 'shape' => 'Timestamp', ], 'Queue' => [ 'shape' => 'QueueReference', ], ], ], 'AgentContactReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentContactReference', ], ], 'AgentFirstName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'sensitive' => true, ], 'AgentHierarchyGroup' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], ], ], 'AgentHierarchyGroups' => [ 'type' => 'structure', 'members' => [ 'L1Ids' => [ 'shape' => 'HierarchyGroupIdList', ], 'L2Ids' => [ 'shape' => 'HierarchyGroupIdList', ], 'L3Ids' => [ 'shape' => 'HierarchyGroupIdList', ], 'L4Ids' => [ 'shape' => 'HierarchyGroupIdList', ], 'L5Ids' => [ 'shape' => 'HierarchyGroupIdList', ], ], ], 'AgentInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'AgentResourceId', ], 'ConnectedToAgentTimestamp' => [ 'shape' => 'timestamp', ], 'AgentPauseDurationInSeconds' => [ 'shape' => 'AgentPauseDurationInSeconds', ], 'HierarchyGroups' => [ 'shape' => 'HierarchyGroups', ], 'DeviceInfo' => [ 'shape' => 'DeviceInfo', ], 'Capabilities' => [ 'shape' => 'ParticipantCapabilities', ], ], ], 'AgentLastName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'sensitive' => true, ], 'AgentPauseDurationInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'AgentQualityMetrics' => [ 'type' => 'structure', 'members' => [ 'Audio' => [ 'shape' => 'AudioQualityMetricsInfo', ], ], ], 'AgentResourceId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'AgentResourceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentResourceId', ], 'max' => 100, 'min' => 0, ], 'AgentStatus' => [ 'type' => 'structure', 'members' => [ 'AgentStatusARN' => [ 'shape' => 'ARN', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', ], 'Name' => [ 'shape' => 'AgentStatusName', ], 'Description' => [ 'shape' => 'AgentStatusDescription', ], 'Type' => [ 'shape' => 'AgentStatusType', ], 'DisplayOrder' => [ 'shape' => 'AgentStatusOrderNumber', ], 'State' => [ 'shape' => 'AgentStatusState', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'AgentStatusDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'AgentStatusId' => [ 'type' => 'string', ], 'AgentStatusName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'AgentStatusOrderNumber' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'AgentStatusReference' => [ 'type' => 'structure', 'members' => [ 'StatusStartTimestamp' => [ 'shape' => 'Timestamp', ], 'StatusArn' => [ 'shape' => 'ARN', ], 'StatusName' => [ 'shape' => 'AgentStatusName', ], ], ], 'AgentStatusState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AgentStatusSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'AgentStatusId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'AgentStatusName', ], 'Type' => [ 'shape' => 'AgentStatusType', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'AgentStatusSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentStatusSummary', ], ], 'AgentStatusType' => [ 'type' => 'string', 'enum' => [ 'ROUTABLE', 'CUSTOM', 'OFFLINE', ], ], 'AgentStatusTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentStatusType', ], 'max' => 3, ], 'AgentUsername' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AgentsMinOneMaxHundred' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserId', ], 'max' => 100, 'min' => 1, ], 'AliasArn' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AllowedAccessControlTags' => [ 'type' => 'map', 'key' => [ 'shape' => 'SecurityProfilePolicyKey', ], 'value' => [ 'shape' => 'SecurityProfilePolicyValue', ], 'max' => 2, ], 'AllowedCapabilities' => [ 'type' => 'structure', 'members' => [ 'Customer' => [ 'shape' => 'ParticipantCapabilities', ], 'Agent' => [ 'shape' => 'ParticipantCapabilities', ], ], ], 'AllowedMonitorCapabilities' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitorCapability', ], 'max' => 2, ], 'AnalyticsDataAssociationResult' => [ 'type' => 'structure', 'members' => [ 'DataSetId' => [ 'shape' => 'DataSetId', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], 'ResourceShareId' => [ 'shape' => 'String', ], 'ResourceShareArn' => [ 'shape' => 'ARN', ], ], ], 'AnalyticsDataAssociationResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalyticsDataAssociationResult', ], ], 'AnswerMachineDetectionConfig' => [ 'type' => 'structure', 'members' => [ 'EnableAnswerMachineDetection' => [ 'shape' => 'Boolean', ], 'AwaitAnswerMachinePrompt' => [ 'shape' => 'Boolean', ], ], ], 'AnsweringMachineDetectionStatus' => [ 'type' => 'string', 'enum' => [ 'ANSWERED', 'UNDETECTED', 'ERROR', 'HUMAN_ANSWERED', 'SIT_TONE_DETECTED', 'SIT_TONE_BUSY', 'SIT_TONE_INVALID_NUMBER', 'FAX_MACHINE_DETECTED', 'VOICEMAIL_BEEP', 'VOICEMAIL_NO_BEEP', 'AMD_UNRESOLVED', 'AMD_UNANSWERED', 'AMD_ERROR', 'AMD_NOT_APPLICABLE', ], ], 'Application' => [ 'type' => 'structure', 'members' => [ 'Namespace' => [ 'shape' => 'Namespace', ], 'ApplicationPermissions' => [ 'shape' => 'ApplicationPermissions', ], ], ], 'ApplicationPermissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Permission', ], 'max' => 10, 'min' => 1, ], 'Applications' => [ 'type' => 'list', 'member' => [ 'shape' => 'Application', ], 'max' => 10, ], 'ApproximateTotalCount' => [ 'type' => 'long', ], 'ArtifactId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ArtifactStatus' => [ 'type' => 'string', 'enum' => [ 'APPROVED', 'REJECTED', 'IN_PROGRESS', ], ], 'AssignContactCategoryActionDefinition' => [ 'type' => 'structure', 'members' => [], ], 'AssociateAnalyticsDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'DataSetId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetId' => [ 'shape' => 'DataSetId', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'AssociateAnalyticsDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetId' => [ 'shape' => 'DataSetId', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], 'ResourceShareId' => [ 'shape' => 'String', ], 'ResourceShareArn' => [ 'shape' => 'ARN', ], ], ], 'AssociateApprovedOriginRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Origin', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Origin' => [ 'shape' => 'Origin', ], ], ], 'AssociateBotRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LexBot' => [ 'shape' => 'LexBot', ], 'LexV2Bot' => [ 'shape' => 'LexV2Bot', ], ], ], 'AssociateDefaultVocabularyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'LanguageCode', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', 'location' => 'uri', 'locationName' => 'LanguageCode', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', ], ], ], 'AssociateDefaultVocabularyResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociateFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceId', 'FlowId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceId' => [ 'shape' => 'ARN', ], 'FlowId' => [ 'shape' => 'ARN', ], 'ResourceType' => [ 'shape' => 'FlowAssociationResourceType', ], ], ], 'AssociateFlowResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociateInstanceStorageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceType', 'StorageConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', ], 'StorageConfig' => [ 'shape' => 'InstanceStorageConfig', ], ], ], 'AssociateInstanceStorageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationId' => [ 'shape' => 'AssociationId', ], ], ], 'AssociateLambdaFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FunctionArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FunctionArn' => [ 'shape' => 'FunctionArn', ], ], ], 'AssociateLexBotRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'LexBot', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LexBot' => [ 'shape' => 'LexBot', ], ], ], 'AssociatePhoneNumberContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', 'InstanceId', 'ContactFlowId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'AssociateQueueQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'QuickConnectIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'QuickConnectIds' => [ 'shape' => 'QuickConnectsList', ], ], ], 'AssociateRoutingProfileQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'QueueConfigs', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'QueueConfigs' => [ 'shape' => 'RoutingProfileQueueConfigList', ], ], ], 'AssociateSecurityKeyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Key', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Key' => [ 'shape' => 'PEM', ], ], ], 'AssociateSecurityKeyResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationId' => [ 'shape' => 'AssociationId', ], ], ], 'AssociateTrafficDistributionGroupUserRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', 'UserId', 'InstanceId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], 'UserId' => [ 'shape' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], ], ], 'AssociateTrafficDistributionGroupUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociateUserProficienciesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', 'UserProficiencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'UserProficiencies' => [ 'shape' => 'UserProficiencyList', ], ], ], 'AssociatedQueueIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueId', ], ], 'AssociationId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AttachedFile' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'FileArn', 'FileId', 'FileName', 'FileSizeInBytes', 'FileStatus', ], 'members' => [ 'CreationTime' => [ 'shape' => 'ISO8601Datetime', ], 'FileArn' => [ 'shape' => 'ARN', ], 'FileId' => [ 'shape' => 'FileId', ], 'FileName' => [ 'shape' => 'FileName', ], 'FileSizeInBytes' => [ 'shape' => 'FileSizeInBytes', 'box' => true, ], 'FileStatus' => [ 'shape' => 'FileStatusType', ], 'CreatedBy' => [ 'shape' => 'CreatedByInfo', ], 'FileUseCaseType' => [ 'shape' => 'FileUseCaseType', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'AttachedFileError' => [ 'type' => 'structure', 'members' => [ 'ErrorCode' => [ 'shape' => 'ErrorCode', ], 'ErrorMessage' => [ 'shape' => 'ErrorMessage', ], 'FileId' => [ 'shape' => 'FileId', ], ], ], 'AttachedFileErrorsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachedFileError', ], ], 'AttachedFileInvalidRequestExceptionReason' => [ 'type' => 'string', 'enum' => [ 'INVALID_FILE_SIZE', 'INVALID_FILE_TYPE', 'INVALID_FILE_NAME', ], ], 'AttachedFilesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachedFile', ], ], 'AttachmentName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'AttachmentReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], 'Status' => [ 'shape' => 'ReferenceStatus', ], ], ], 'Attendee' => [ 'type' => 'structure', 'members' => [ 'AttendeeId' => [ 'shape' => 'AttendeeId', ], 'JoinToken' => [ 'shape' => 'JoinToken', ], ], ], 'AttendeeId' => [ 'type' => 'string', ], 'Attribute' => [ 'type' => 'structure', 'members' => [ 'AttributeType' => [ 'shape' => 'InstanceAttributeType', ], 'Value' => [ 'shape' => 'InstanceAttributeValue', ], ], ], 'AttributeAndCondition' => [ 'type' => 'structure', 'members' => [ 'TagConditions' => [ 'shape' => 'TagAndConditionList', ], 'HierarchyGroupCondition' => [ 'shape' => 'HierarchyGroupCondition', ], ], ], 'AttributeCondition' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'PredefinedAttributeName', ], 'Value' => [ 'shape' => 'ProficiencyValue', ], 'ProficiencyLevel' => [ 'shape' => 'ProficiencyLevel', ], 'ComparisonOperator' => [ 'shape' => 'ComparisonOperator', ], ], ], 'AttributeName' => [ 'type' => 'string', 'max' => 32767, 'min' => 1, ], 'AttributeOrConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeAndCondition', ], ], 'AttributeValue' => [ 'type' => 'string', 'max' => 32767, 'min' => 0, ], 'Attributes' => [ 'type' => 'map', 'key' => [ 'shape' => 'AttributeName', ], 'value' => [ 'shape' => 'AttributeValue', ], ], 'AttributesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'AudioFeatures' => [ 'type' => 'structure', 'members' => [ 'EchoReduction' => [ 'shape' => 'MeetingFeatureStatus', ], ], ], 'AudioQualityMetricsInfo' => [ 'type' => 'structure', 'members' => [ 'QualityScore' => [ 'shape' => 'AudioQualityScore', ], 'PotentialQualityIssues' => [ 'shape' => 'PotentialAudioQualityIssues', ], ], ], 'AudioQualityScore' => [ 'type' => 'float', ], 'AutoAccept' => [ 'type' => 'boolean', ], 'AvailableNumberSummary' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], ], ], 'AvailableNumbersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailableNumberSummary', ], ], 'AwsRegion' => [ 'type' => 'string', 'max' => 31, 'min' => 8, 'pattern' => '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?', ], 'BatchAssociateAnalyticsDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'DataSetIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetIds' => [ 'shape' => 'DataSetIds', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'BatchAssociateAnalyticsDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Created' => [ 'shape' => 'AnalyticsDataAssociationResults', ], 'Errors' => [ 'shape' => 'ErrorResults', ], ], ], 'BatchDisassociateAnalyticsDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'DataSetIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetIds' => [ 'shape' => 'DataSetIds', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'BatchDisassociateAnalyticsDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Deleted' => [ 'shape' => 'DataSetIds', ], 'Errors' => [ 'shape' => 'ErrorResults', ], ], ], 'BatchGetAttachedFileMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FileIds', 'InstanceId', 'AssociatedResourceArn', ], 'members' => [ 'FileIds' => [ 'shape' => 'FileIdList', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], ], ], 'BatchGetAttachedFileMetadataResponse' => [ 'type' => 'structure', 'members' => [ 'Files' => [ 'shape' => 'AttachedFilesList', ], 'Errors' => [ 'shape' => 'AttachedFileErrorsList', ], ], ], 'BatchGetFlowAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceIds' => [ 'shape' => 'resourceArnListMaxLimit100', ], 'ResourceType' => [ 'shape' => 'ListFlowAssociationResourceType', ], ], ], 'BatchGetFlowAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'FlowAssociationSummaryList' => [ 'shape' => 'FlowAssociationSummaryList', ], ], ], 'BatchPutContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactDataRequestList', ], 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactDataRequestList' => [ 'shape' => 'ContactDataRequestList', ], ], ], 'BatchPutContactResponse' => [ 'type' => 'structure', 'members' => [ 'SuccessfulRequestList' => [ 'shape' => 'SuccessfulRequestList', ], 'FailedRequestList' => [ 'shape' => 'FailedRequestList', ], ], ], 'BehaviorType' => [ 'type' => 'string', 'enum' => [ 'ROUTE_CURRENT_CHANNEL_ONLY', 'ROUTE_ANY_CHANNEL', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BotName' => [ 'type' => 'string', 'max' => 50, ], 'BoxedBoolean' => [ 'type' => 'boolean', ], 'BucketName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'Campaign' => [ 'type' => 'structure', 'members' => [ 'CampaignId' => [ 'shape' => 'CampaignId', ], ], ], 'CampaignId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'Channel' => [ 'type' => 'string', 'enum' => [ 'VOICE', 'CHAT', 'TASK', ], ], 'ChannelList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], ], 'ChannelToCountMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'Channel', ], 'value' => [ 'shape' => 'IntegerCount', ], ], 'Channels' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], 'max' => 3, ], 'ChatContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, ], 'ChatContentType' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'ChatDurationInMinutes' => [ 'type' => 'integer', 'max' => 10080, 'min' => 60, ], 'ChatEvent' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'ChatEventType', ], 'ContentType' => [ 'shape' => 'ChatContentType', ], 'Content' => [ 'shape' => 'ChatContent', ], ], ], 'ChatEventType' => [ 'type' => 'string', 'enum' => [ 'DISCONNECT', 'MESSAGE', 'EVENT', ], ], 'ChatMessage' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'Content', ], 'members' => [ 'ContentType' => [ 'shape' => 'ChatContentType', ], 'Content' => [ 'shape' => 'ChatContent', ], ], ], 'ChatParticipantRoleConfig' => [ 'type' => 'structure', 'required' => [ 'ParticipantTimerConfigList', ], 'members' => [ 'ParticipantTimerConfigList' => [ 'shape' => 'ParticipantTimerConfigList', ], ], ], 'ChatStreamingConfiguration' => [ 'type' => 'structure', 'required' => [ 'StreamingEndpointArn', ], 'members' => [ 'StreamingEndpointArn' => [ 'shape' => 'ChatStreamingEndpointARN', ], ], ], 'ChatStreamingEndpointARN' => [ 'type' => 'string', 'max' => 350, 'min' => 1, ], 'ClaimPhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumber', ], 'members' => [ 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'ClaimPhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'ClaimedPhoneNumberSummary' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Tags' => [ 'shape' => 'TagMap', ], 'PhoneNumberStatus' => [ 'shape' => 'PhoneNumberStatus', ], 'SourcePhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 500, ], 'CommonNameLength127' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'Comparison' => [ 'type' => 'string', 'enum' => [ 'LT', ], ], 'ComparisonOperator' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'CompleteAttachedFileUploadRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FileId', 'AssociatedResourceArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FileId' => [ 'shape' => 'FileId', 'location' => 'uri', 'locationName' => 'FileId', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], ], ], 'CompleteAttachedFileUploadResponse' => [ 'type' => 'structure', 'members' => [], ], 'Concurrency' => [ 'type' => 'integer', 'max' => 10, 'min' => 1, ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectionData' => [ 'type' => 'structure', 'members' => [ 'Attendee' => [ 'shape' => 'Attendee', ], 'Meeting' => [ 'shape' => 'Meeting', ], ], ], 'Contact' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'Id' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], 'PreviousContactId' => [ 'shape' => 'ContactId', ], 'InitiationMethod' => [ 'shape' => 'ContactInitiationMethod', ], 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'Channel' => [ 'shape' => 'Channel', ], 'QueueInfo' => [ 'shape' => 'QueueInfo', ], 'AgentInfo' => [ 'shape' => 'AgentInfo', ], 'InitiationTimestamp' => [ 'shape' => 'timestamp', ], 'DisconnectTimestamp' => [ 'shape' => 'timestamp', ], 'LastUpdateTimestamp' => [ 'shape' => 'timestamp', ], 'LastPausedTimestamp' => [ 'shape' => 'timestamp', ], 'LastResumedTimestamp' => [ 'shape' => 'timestamp', ], 'TotalPauseCount' => [ 'shape' => 'TotalPauseCount', ], 'TotalPauseDurationInSeconds' => [ 'shape' => 'TotalPauseDurationInSeconds', ], 'ScheduledTimestamp' => [ 'shape' => 'timestamp', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], 'WisdomInfo' => [ 'shape' => 'WisdomInfo', ], 'QueueTimeAdjustmentSeconds' => [ 'shape' => 'QueueTimeAdjustmentSeconds', ], 'QueuePriority' => [ 'shape' => 'QueuePriority', ], 'Tags' => [ 'shape' => 'ContactTagMap', ], 'ConnectedToSystemTimestamp' => [ 'shape' => 'timestamp', ], 'RoutingCriteria' => [ 'shape' => 'RoutingCriteria', ], 'Customer' => [ 'shape' => 'Customer', ], 'Campaign' => [ 'shape' => 'Campaign', ], 'AnsweringMachineDetectionStatus' => [ 'shape' => 'AnsweringMachineDetectionStatus', ], 'CustomerVoiceActivity' => [ 'shape' => 'CustomerVoiceActivity', ], 'QualityMetrics' => [ 'shape' => 'QualityMetrics', ], 'DisconnectDetails' => [ 'shape' => 'DisconnectDetails', ], 'SegmentAttributes' => [ 'shape' => 'SegmentAttributes', ], ], ], 'ContactAnalysis' => [ 'type' => 'structure', 'members' => [ 'Transcript' => [ 'shape' => 'Transcript', ], ], ], 'ContactDataRequest' => [ 'type' => 'structure', 'members' => [ 'SystemEndpoint' => [ 'shape' => 'Endpoint', ], 'CustomerEndpoint' => [ 'shape' => 'Endpoint', ], 'RequestIdentifier' => [ 'shape' => 'RequestIdentifier', ], 'QueueId' => [ 'shape' => 'QueueId', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'Campaign' => [ 'shape' => 'Campaign', ], ], ], 'ContactDataRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactDataRequest', ], 'max' => 25, 'min' => 1, ], 'ContactFilter' => [ 'type' => 'structure', 'members' => [ 'ContactStates' => [ 'shape' => 'ContactStates', ], ], ], 'ContactFlow' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'Id' => [ 'shape' => 'ContactFlowId', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'Type' => [ 'shape' => 'ContactFlowType', ], 'State' => [ 'shape' => 'ContactFlowState', ], 'Status' => [ 'shape' => 'ContactFlowStatus', ], 'Description' => [ 'shape' => 'ContactFlowDescription', ], 'Content' => [ 'shape' => 'ContactFlowContent', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'ContactFlowContent' => [ 'type' => 'string', ], 'ContactFlowDescription' => [ 'type' => 'string', ], 'ContactFlowId' => [ 'type' => 'string', 'max' => 500, ], 'ContactFlowModule' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'Id' => [ 'shape' => 'ContactFlowModuleId', ], 'Name' => [ 'shape' => 'ContactFlowModuleName', ], 'Content' => [ 'shape' => 'ContactFlowModuleContent', ], 'Description' => [ 'shape' => 'ContactFlowModuleDescription', ], 'State' => [ 'shape' => 'ContactFlowModuleState', ], 'Status' => [ 'shape' => 'ContactFlowModuleStatus', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'ContactFlowModuleContent' => [ 'type' => 'string', 'max' => 256000, 'min' => 1, ], 'ContactFlowModuleDescription' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '.*\\S.*', ], 'ContactFlowModuleId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContactFlowModuleName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ContactFlowModuleSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowModuleSearchCriteria', ], ], 'ContactFlowModuleSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'ContactFlowModuleSearchConditionList', ], 'AndConditions' => [ 'shape' => 'ContactFlowModuleSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'ContactFlowModuleSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'ContactFlowModuleSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowModule', ], ], 'ContactFlowModuleState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'ARCHIVED', ], ], 'ContactFlowModuleStatus' => [ 'type' => 'string', 'enum' => [ 'PUBLISHED', 'SAVED', ], ], 'ContactFlowModuleSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ContactFlowModuleId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'ContactFlowModuleName', ], 'State' => [ 'shape' => 'ContactFlowModuleState', ], ], ], 'ContactFlowModulesSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowModuleSummary', ], ], 'ContactFlowName' => [ 'type' => 'string', 'min' => 1, ], 'ContactFlowNotPublishedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ContactFlowSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowSearchCriteria', ], ], 'ContactFlowSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'ContactFlowSearchConditionList', ], 'AndConditions' => [ 'shape' => 'ContactFlowSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], 'TypeCondition' => [ 'shape' => 'ContactFlowType', ], 'StateCondition' => [ 'shape' => 'ContactFlowState', ], 'StatusCondition' => [ 'shape' => 'ContactFlowStatus', ], ], ], 'ContactFlowSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'ContactFlowSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlow', ], ], 'ContactFlowState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'ARCHIVED', ], ], 'ContactFlowStatus' => [ 'type' => 'string', 'enum' => [ 'PUBLISHED', 'SAVED', ], ], 'ContactFlowSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ContactFlowId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'ContactFlowType' => [ 'shape' => 'ContactFlowType', ], 'ContactFlowState' => [ 'shape' => 'ContactFlowState', ], 'ContactFlowStatus' => [ 'shape' => 'ContactFlowStatus', ], ], ], 'ContactFlowSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowSummary', ], ], 'ContactFlowType' => [ 'type' => 'string', 'enum' => [ 'CONTACT_FLOW', 'CUSTOMER_QUEUE', 'CUSTOMER_HOLD', 'CUSTOMER_WHISPER', 'AGENT_HOLD', 'AGENT_WHISPER', 'OUTBOUND_WHISPER', 'AGENT_TRANSFER', 'QUEUE_TRANSFER', ], ], 'ContactFlowTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowType', ], 'max' => 10, ], 'ContactId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContactInitiationMethod' => [ 'type' => 'string', 'enum' => [ 'INBOUND', 'OUTBOUND', 'TRANSFER', 'QUEUE_TRANSFER', 'CALLBACK', 'API', 'DISCONNECT', 'MONITOR', 'EXTERNAL_OUTBOUND', ], ], 'ContactNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], 'ContactReferences' => [ 'type' => 'map', 'key' => [ 'shape' => 'ReferenceKey', ], 'value' => [ 'shape' => 'Reference', ], ], 'ContactSearchSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'Id' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], 'PreviousContactId' => [ 'shape' => 'ContactId', ], 'InitiationMethod' => [ 'shape' => 'ContactInitiationMethod', ], 'Channel' => [ 'shape' => 'Channel', ], 'QueueInfo' => [ 'shape' => 'ContactSearchSummaryQueueInfo', ], 'AgentInfo' => [ 'shape' => 'ContactSearchSummaryAgentInfo', ], 'InitiationTimestamp' => [ 'shape' => 'timestamp', ], 'DisconnectTimestamp' => [ 'shape' => 'timestamp', ], 'ScheduledTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'ContactSearchSummaryAgentInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'AgentResourceId', ], 'ConnectedToAgentTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'ContactSearchSummaryQueueInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QueueId', ], 'EnqueueTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'ContactState' => [ 'type' => 'string', 'enum' => [ 'INCOMING', 'PENDING', 'CONNECTING', 'CONNECTED', 'CONNECTED_ONHOLD', 'MISSED', 'ERROR', 'ENDED', 'REJECTED', ], ], 'ContactStates' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactState', ], 'max' => 9, ], 'ContactTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^(?!aws:)[a-zA-Z+-=._:/]+$', ], 'ContactTagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactTagKey', ], 'max' => 6, 'min' => 1, ], 'ContactTagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ContactTagKey', ], 'value' => [ 'shape' => 'ContactTagValue', ], 'max' => 6, 'min' => 1, ], 'ContactTagValue' => [ 'type' => 'string', 'max' => 256, ], 'Contacts' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactSearchSummary', ], ], 'Content' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ContentType' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ControlPlaneTagFilter' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'TagOrConditionList', ], 'AndConditions' => [ 'shape' => 'TagAndConditionList', ], 'TagCondition' => [ 'shape' => 'TagCondition', ], ], ], 'ControlPlaneUserAttributeFilter' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'AttributeOrConditionList', ], 'AndCondition' => [ 'shape' => 'AttributeAndCondition', ], 'TagCondition' => [ 'shape' => 'TagCondition', ], 'HierarchyGroupCondition' => [ 'shape' => 'HierarchyGroupCondition', ], ], ], 'CreateAgentStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'State', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'AgentStatusName', ], 'Description' => [ 'shape' => 'AgentStatusDescription', ], 'State' => [ 'shape' => 'AgentStatusState', ], 'DisplayOrder' => [ 'shape' => 'AgentStatusOrderNumber', 'box' => true, ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateAgentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'AgentStatusARN' => [ 'shape' => 'ARN', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', ], ], ], 'CreateCaseActionDefinition' => [ 'type' => 'structure', 'required' => [ 'Fields', 'TemplateId', ], 'members' => [ 'Fields' => [ 'shape' => 'FieldValues', ], 'TemplateId' => [ 'shape' => 'TemplateId', ], ], ], 'CreateContactFlowModuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'ContactFlowModuleName', ], 'Description' => [ 'shape' => 'ContactFlowModuleDescription', ], 'Content' => [ 'shape' => 'ContactFlowModuleContent', ], 'Tags' => [ 'shape' => 'TagMap', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateContactFlowModuleResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ContactFlowModuleId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'CreateContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Type', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'Type' => [ 'shape' => 'ContactFlowType', ], 'Description' => [ 'shape' => 'ContactFlowDescription', ], 'Content' => [ 'shape' => 'ContactFlowContent', ], 'Status' => [ 'shape' => 'ContactFlowStatus', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateContactFlowResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'ContactFlowArn' => [ 'shape' => 'ARN', ], ], ], 'CreateEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Title', 'Items', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'Description' => [ 'shape' => 'EvaluationFormDescription', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'ScoringStrategy' => [ 'shape' => 'EvaluationFormScoringStrategy', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], ], ], 'CreateHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'TimeZone', 'Config', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'HoursOfOperationDescription', ], 'TimeZone' => [ 'shape' => 'TimeZone', ], 'Config' => [ 'shape' => 'HoursOfOperationConfigList', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateHoursOfOperationResponse' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], 'HoursOfOperationArn' => [ 'shape' => 'ARN', ], ], ], 'CreateInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'IdentityManagementType', 'InboundCallsEnabled', 'OutboundCallsEnabled', ], 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', ], 'IdentityManagementType' => [ 'shape' => 'DirectoryType', ], 'InstanceAlias' => [ 'shape' => 'DirectoryAlias', ], 'DirectoryId' => [ 'shape' => 'DirectoryId', ], 'InboundCallsEnabled' => [ 'shape' => 'InboundCallsEnabled', ], 'OutboundCallsEnabled' => [ 'shape' => 'OutboundCallsEnabled', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'CreateIntegrationAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationType', 'IntegrationArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationType' => [ 'shape' => 'IntegrationType', ], 'IntegrationArn' => [ 'shape' => 'ARN', ], 'SourceApplicationUrl' => [ 'shape' => 'URI', ], 'SourceApplicationName' => [ 'shape' => 'SourceApplicationName', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateIntegrationAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', ], 'IntegrationAssociationArn' => [ 'shape' => 'ARN', ], ], ], 'CreateParticipantRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ParticipantDetails', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ParticipantDetails' => [ 'shape' => 'ParticipantDetailsToAdd', ], ], ], 'CreateParticipantResponse' => [ 'type' => 'structure', 'members' => [ 'ParticipantCredentials' => [ 'shape' => 'ParticipantTokenCredentials', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], ], ], 'CreatePersistentContactAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'InitialContactId', 'RehydrationType', 'SourceContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'InitialContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'InitialContactId', ], 'RehydrationType' => [ 'shape' => 'RehydrationType', ], 'SourceContactId' => [ 'shape' => 'ContactId', ], 'ClientToken' => [ 'shape' => 'ClientToken', ], ], ], 'CreatePersistentContactAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'ContinuedFromContactId' => [ 'shape' => 'ContactId', ], ], ], 'CreatePredefinedAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Values', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'PredefinedAttributeName', ], 'Values' => [ 'shape' => 'PredefinedAttributeValues', ], ], ], 'CreatePromptRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'S3Uri', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'PromptDescription', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreatePromptResponse' => [ 'type' => 'structure', 'members' => [ 'PromptARN' => [ 'shape' => 'ARN', ], 'PromptId' => [ 'shape' => 'PromptId', ], ], ], 'CreateQueueRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'QueueDescription', ], 'OutboundCallerConfig' => [ 'shape' => 'OutboundCallerConfig', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], 'MaxContacts' => [ 'shape' => 'QueueMaxContacts', 'box' => true, ], 'QuickConnectIds' => [ 'shape' => 'QuickConnectsList', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateQueueResponse' => [ 'type' => 'structure', 'members' => [ 'QueueArn' => [ 'shape' => 'ARN', ], 'QueueId' => [ 'shape' => 'QueueId', ], ], ], 'CreateQuickConnectRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'QuickConnectConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'QuickConnectName', ], 'Description' => [ 'shape' => 'QuickConnectDescription', ], 'QuickConnectConfig' => [ 'shape' => 'QuickConnectConfig', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateQuickConnectResponse' => [ 'type' => 'structure', 'members' => [ 'QuickConnectARN' => [ 'shape' => 'ARN', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', ], ], ], 'CreateRoutingProfileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Description', 'DefaultOutboundQueueId', 'MediaConcurrencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'RoutingProfileName', ], 'Description' => [ 'shape' => 'RoutingProfileDescription', ], 'DefaultOutboundQueueId' => [ 'shape' => 'QueueId', ], 'QueueConfigs' => [ 'shape' => 'RoutingProfileQueueConfigList', ], 'MediaConcurrencies' => [ 'shape' => 'MediaConcurrencies', ], 'Tags' => [ 'shape' => 'TagMap', ], 'AgentAvailabilityTimer' => [ 'shape' => 'AgentAvailabilityTimer', ], ], ], 'CreateRoutingProfileResponse' => [ 'type' => 'structure', 'members' => [ 'RoutingProfileArn' => [ 'shape' => 'ARN', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], ], ], 'CreateRuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'TriggerEventSource', 'Function', 'Actions', 'PublishStatus', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'RuleName', ], 'TriggerEventSource' => [ 'shape' => 'RuleTriggerEventSource', ], 'Function' => [ 'shape' => 'RuleFunction', ], 'Actions' => [ 'shape' => 'RuleActions', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateRuleResponse' => [ 'type' => 'structure', 'required' => [ 'RuleArn', 'RuleId', ], 'members' => [ 'RuleArn' => [ 'shape' => 'ARN', ], 'RuleId' => [ 'shape' => 'RuleId', ], ], ], 'CreateSecurityProfileName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '^[ a-zA-Z0-9_@-]+$', ], 'CreateSecurityProfileRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileName', 'InstanceId', ], 'members' => [ 'SecurityProfileName' => [ 'shape' => 'CreateSecurityProfileName', ], 'Description' => [ 'shape' => 'SecurityProfileDescription', ], 'Permissions' => [ 'shape' => 'PermissionsList', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Tags' => [ 'shape' => 'TagMap', ], 'AllowedAccessControlTags' => [ 'shape' => 'AllowedAccessControlTags', ], 'TagRestrictedResources' => [ 'shape' => 'TagRestrictedResourceList', ], 'Applications' => [ 'shape' => 'Applications', ], 'HierarchyRestrictedResources' => [ 'shape' => 'HierarchyRestrictedResourceList', ], 'AllowedAccessControlHierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], ], ], 'CreateSecurityProfileResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', ], 'SecurityProfileArn' => [ 'shape' => 'ARN', ], ], ], 'CreateTaskTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Fields', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Constraints' => [ 'shape' => 'TaskTemplateConstraints', ], 'Defaults' => [ 'shape' => 'TaskTemplateDefaults', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'Fields' => [ 'shape' => 'TaskTemplateFields', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateTaskTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'Id', 'Arn', ], 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateId', ], 'Arn' => [ 'shape' => 'TaskTemplateArn', ], ], ], 'CreateTrafficDistributionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'InstanceId', ], 'members' => [ 'Name' => [ 'shape' => 'Name128', ], 'Description' => [ 'shape' => 'Description250', ], 'InstanceId' => [ 'shape' => 'InstanceIdOrArn', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateTrafficDistributionGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupId', ], 'Arn' => [ 'shape' => 'TrafficDistributionGroupArn', ], ], ], 'CreateUseCaseRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationAssociationId', 'UseCaseType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', 'location' => 'uri', 'locationName' => 'IntegrationAssociationId', ], 'UseCaseType' => [ 'shape' => 'UseCaseType', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateUseCaseResponse' => [ 'type' => 'structure', 'members' => [ 'UseCaseId' => [ 'shape' => 'UseCaseId', ], 'UseCaseArn' => [ 'shape' => 'ARN', ], ], ], 'CreateUserHierarchyGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'InstanceId', ], 'members' => [ 'Name' => [ 'shape' => 'HierarchyGroupName', ], 'ParentGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateUserHierarchyGroupResponse' => [ 'type' => 'structure', 'members' => [ 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'HierarchyGroupArn' => [ 'shape' => 'ARN', ], ], ], 'CreateUserRequest' => [ 'type' => 'structure', 'required' => [ 'Username', 'PhoneConfig', 'SecurityProfileIds', 'RoutingProfileId', 'InstanceId', ], 'members' => [ 'Username' => [ 'shape' => 'AgentUsername', ], 'Password' => [ 'shape' => 'Password', ], 'IdentityInfo' => [ 'shape' => 'UserIdentityInfo', ], 'PhoneConfig' => [ 'shape' => 'UserPhoneConfig', ], 'DirectoryUserId' => [ 'shape' => 'DirectoryUserId', ], 'SecurityProfileIds' => [ 'shape' => 'SecurityProfileIds', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateUserResponse' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], 'UserArn' => [ 'shape' => 'ARN', ], ], ], 'CreateViewRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Status', 'Content', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ClientToken' => [ 'shape' => 'ViewsClientToken', ], 'Status' => [ 'shape' => 'ViewStatus', ], 'Content' => [ 'shape' => 'ViewInputContent', ], 'Description' => [ 'shape' => 'ViewDescription', ], 'Name' => [ 'shape' => 'ViewName', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateViewResponse' => [ 'type' => 'structure', 'members' => [ 'View' => [ 'shape' => 'View', ], ], ], 'CreateViewVersionRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'VersionDescription' => [ 'shape' => 'ViewDescription', ], 'ViewContentSha256' => [ 'shape' => 'ViewContentSha256', ], ], ], 'CreateViewVersionResponse' => [ 'type' => 'structure', 'members' => [ 'View' => [ 'shape' => 'View', ], ], ], 'CreateVocabularyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'VocabularyName', 'LanguageCode', 'Content', ], 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'VocabularyName' => [ 'shape' => 'VocabularyName', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'Content' => [ 'shape' => 'VocabularyContent', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateVocabularyResponse' => [ 'type' => 'structure', 'required' => [ 'VocabularyArn', 'VocabularyId', 'State', ], 'members' => [ 'VocabularyArn' => [ 'shape' => 'ARN', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', ], 'State' => [ 'shape' => 'VocabularyState', ], ], ], 'CreatedByInfo' => [ 'type' => 'structure', 'members' => [ 'ConnectUserArn' => [ 'shape' => 'ARN', ], 'AWSIdentityArn' => [ 'shape' => 'ARN', ], ], 'union' => true, ], 'Credentials' => [ 'type' => 'structure', 'members' => [ 'AccessToken' => [ 'shape' => 'SecurityToken', ], 'AccessTokenExpiration' => [ 'shape' => 'timestamp', ], 'RefreshToken' => [ 'shape' => 'SecurityToken', ], 'RefreshTokenExpiration' => [ 'shape' => 'timestamp', ], ], 'sensitive' => true, ], 'CrossChannelBehavior' => [ 'type' => 'structure', 'required' => [ 'BehaviorType', ], 'members' => [ 'BehaviorType' => [ 'shape' => 'BehaviorType', ], ], ], 'CurrentMetric' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'CurrentMetricName', ], 'Unit' => [ 'shape' => 'Unit', ], ], ], 'CurrentMetricData' => [ 'type' => 'structure', 'members' => [ 'Metric' => [ 'shape' => 'CurrentMetric', ], 'Value' => [ 'shape' => 'Value', 'box' => true, ], ], ], 'CurrentMetricDataCollections' => [ 'type' => 'list', 'member' => [ 'shape' => 'CurrentMetricData', ], ], 'CurrentMetricName' => [ 'type' => 'string', 'enum' => [ 'AGENTS_ONLINE', 'AGENTS_AVAILABLE', 'AGENTS_ON_CALL', 'AGENTS_NON_PRODUCTIVE', 'AGENTS_AFTER_CONTACT_WORK', 'AGENTS_ERROR', 'AGENTS_STAFFED', 'CONTACTS_IN_QUEUE', 'OLDEST_CONTACT_AGE', 'CONTACTS_SCHEDULED', 'AGENTS_ON_CONTACT', 'SLOTS_ACTIVE', 'SLOTS_AVAILABLE', ], ], 'CurrentMetricResult' => [ 'type' => 'structure', 'members' => [ 'Dimensions' => [ 'shape' => 'Dimensions', ], 'Collections' => [ 'shape' => 'CurrentMetricDataCollections', ], ], ], 'CurrentMetricResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'CurrentMetricResult', ], ], 'CurrentMetricSortCriteria' => [ 'type' => 'structure', 'members' => [ 'SortByMetric' => [ 'shape' => 'CurrentMetricName', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'CurrentMetricSortCriteriaMaxOne' => [ 'type' => 'list', 'member' => [ 'shape' => 'CurrentMetricSortCriteria', ], 'max' => 1, 'min' => 0, ], 'CurrentMetrics' => [ 'type' => 'list', 'member' => [ 'shape' => 'CurrentMetric', ], ], 'Customer' => [ 'type' => 'structure', 'members' => [ 'DeviceInfo' => [ 'shape' => 'DeviceInfo', ], 'Capabilities' => [ 'shape' => 'ParticipantCapabilities', ], ], ], 'CustomerQualityMetrics' => [ 'type' => 'structure', 'members' => [ 'Audio' => [ 'shape' => 'AudioQualityMetricsInfo', ], ], ], 'CustomerVoiceActivity' => [ 'type' => 'structure', 'members' => [ 'GreetingStartTimestamp' => [ 'shape' => 'timestamp', ], 'GreetingEndTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'DataSetId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'DataSetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetId', ], ], 'DateReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'DeactivateEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', 'EvaluationFormVersion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'DeactivateEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', 'EvaluationFormVersion', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'DefaultVocabulary' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'LanguageCode', 'VocabularyId', 'VocabularyName', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', ], 'VocabularyName' => [ 'shape' => 'VocabularyName', ], ], ], 'DefaultVocabularyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefaultVocabulary', ], ], 'Delay' => [ 'type' => 'integer', 'max' => 9999, 'min' => 0, ], 'DeleteAttachedFileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FileId', 'AssociatedResourceArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FileId' => [ 'shape' => 'FileId', 'location' => 'uri', 'locationName' => 'FileId', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], ], ], 'DeleteAttachedFileResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationId', ], ], ], 'DeleteContactFlowModuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowModuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowModuleId' => [ 'shape' => 'ContactFlowModuleId', 'location' => 'uri', 'locationName' => 'ContactFlowModuleId', ], ], ], 'DeleteContactFlowModuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], ], ], 'DeleteContactFlowResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', 'box' => true, 'location' => 'querystring', 'locationName' => 'version', ], ], ], 'DeleteHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', 'location' => 'uri', 'locationName' => 'HoursOfOperationId', ], ], ], 'DeleteInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DeleteIntegrationAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationAssociationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', 'location' => 'uri', 'locationName' => 'IntegrationAssociationId', ], ], ], 'DeletePredefinedAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'PredefinedAttributeName', 'location' => 'uri', 'locationName' => 'Name', ], ], ], 'DeletePromptRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'PromptId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PromptId' => [ 'shape' => 'PromptId', 'location' => 'uri', 'locationName' => 'PromptId', ], ], ], 'DeleteQueueRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], ], ], 'DeleteQuickConnectRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QuickConnectId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', 'location' => 'uri', 'locationName' => 'QuickConnectId', ], ], ], 'DeleteRoutingProfileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], ], ], 'DeleteRuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RuleId' => [ 'shape' => 'RuleId', 'location' => 'uri', 'locationName' => 'RuleId', ], ], ], 'DeleteSecurityProfileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'SecurityProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], ], ], 'DeleteTaskTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'TaskTemplateId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'TaskTemplateId' => [ 'shape' => 'TaskTemplateId', 'location' => 'uri', 'locationName' => 'TaskTemplateId', ], ], ], 'DeleteTaskTemplateResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTrafficDistributionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], ], ], 'DeleteTrafficDistributionGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUseCaseRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationAssociationId', 'UseCaseId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', 'location' => 'uri', 'locationName' => 'IntegrationAssociationId', ], 'UseCaseId' => [ 'shape' => 'UseCaseId', 'location' => 'uri', 'locationName' => 'UseCaseId', ], ], ], 'DeleteUserHierarchyGroupRequest' => [ 'type' => 'structure', 'required' => [ 'HierarchyGroupId', 'InstanceId', ], 'members' => [ 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', 'location' => 'uri', 'locationName' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], ], ], 'DeleteViewRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], ], ], 'DeleteViewResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteViewVersionRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', 'ViewVersion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'ViewVersion' => [ 'shape' => 'ViewVersion', 'location' => 'uri', 'locationName' => 'ViewVersion', ], ], ], 'DeleteViewVersionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteVocabularyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'VocabularyId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', 'location' => 'uri', 'locationName' => 'VocabularyId', ], ], ], 'DeleteVocabularyResponse' => [ 'type' => 'structure', 'required' => [ 'VocabularyArn', 'VocabularyId', 'State', ], 'members' => [ 'VocabularyArn' => [ 'shape' => 'ARN', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', ], 'State' => [ 'shape' => 'VocabularyState', ], ], ], 'DescribeAgentStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AgentStatusId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', 'location' => 'uri', 'locationName' => 'AgentStatusId', ], ], ], 'DescribeAgentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'AgentStatus' => [ 'shape' => 'AgentStatus', ], ], ], 'DescribeContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationId', ], ], ], 'DescribeContactEvaluationResponse' => [ 'type' => 'structure', 'required' => [ 'Evaluation', 'EvaluationForm', ], 'members' => [ 'Evaluation' => [ 'shape' => 'Evaluation', ], 'EvaluationForm' => [ 'shape' => 'EvaluationFormContent', ], ], ], 'DescribeContactFlowModuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowModuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowModuleId' => [ 'shape' => 'ContactFlowModuleId', 'location' => 'uri', 'locationName' => 'ContactFlowModuleId', ], ], ], 'DescribeContactFlowModuleResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowModule' => [ 'shape' => 'ContactFlowModule', ], ], ], 'DescribeContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], ], ], 'DescribeContactFlowResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlow' => [ 'shape' => 'ContactFlow', ], ], ], 'DescribeContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], ], ], 'DescribeContactResponse' => [ 'type' => 'structure', 'members' => [ 'Contact' => [ 'shape' => 'Contact', ], ], ], 'DescribeEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', 'box' => true, 'location' => 'querystring', 'locationName' => 'version', ], ], ], 'DescribeEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationForm', ], 'members' => [ 'EvaluationForm' => [ 'shape' => 'EvaluationForm', ], ], ], 'DescribeHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', 'location' => 'uri', 'locationName' => 'HoursOfOperationId', ], ], ], 'DescribeHoursOfOperationResponse' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperation' => [ 'shape' => 'HoursOfOperation', ], ], ], 'DescribeInstanceAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AttributeType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AttributeType' => [ 'shape' => 'InstanceAttributeType', 'location' => 'uri', 'locationName' => 'AttributeType', ], ], ], 'DescribeInstanceAttributeResponse' => [ 'type' => 'structure', 'members' => [ 'Attribute' => [ 'shape' => 'Attribute', ], ], ], 'DescribeInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'Instance' => [ 'shape' => 'Instance', ], ], ], 'DescribeInstanceStorageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AssociationId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociationId' => [ 'shape' => 'AssociationId', 'location' => 'uri', 'locationName' => 'AssociationId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', 'location' => 'querystring', 'locationName' => 'resourceType', ], ], ], 'DescribeInstanceStorageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StorageConfig' => [ 'shape' => 'InstanceStorageConfig', ], ], ], 'DescribePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], ], ], 'DescribePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'ClaimedPhoneNumberSummary' => [ 'shape' => 'ClaimedPhoneNumberSummary', ], ], ], 'DescribePredefinedAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'PredefinedAttributeName', 'location' => 'uri', 'locationName' => 'Name', ], ], ], 'DescribePredefinedAttributeResponse' => [ 'type' => 'structure', 'members' => [ 'PredefinedAttribute' => [ 'shape' => 'PredefinedAttribute', ], ], ], 'DescribePromptRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'PromptId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PromptId' => [ 'shape' => 'PromptId', 'location' => 'uri', 'locationName' => 'PromptId', ], ], ], 'DescribePromptResponse' => [ 'type' => 'structure', 'members' => [ 'Prompt' => [ 'shape' => 'Prompt', ], ], ], 'DescribeQueueRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], ], ], 'DescribeQueueResponse' => [ 'type' => 'structure', 'members' => [ 'Queue' => [ 'shape' => 'Queue', ], ], ], 'DescribeQuickConnectRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QuickConnectId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', 'location' => 'uri', 'locationName' => 'QuickConnectId', ], ], ], 'DescribeQuickConnectResponse' => [ 'type' => 'structure', 'members' => [ 'QuickConnect' => [ 'shape' => 'QuickConnect', ], ], ], 'DescribeRoutingProfileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], ], ], 'DescribeRoutingProfileResponse' => [ 'type' => 'structure', 'members' => [ 'RoutingProfile' => [ 'shape' => 'RoutingProfile', ], ], ], 'DescribeRuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RuleId' => [ 'shape' => 'RuleId', 'location' => 'uri', 'locationName' => 'RuleId', ], ], ], 'DescribeRuleResponse' => [ 'type' => 'structure', 'required' => [ 'Rule', ], 'members' => [ 'Rule' => [ 'shape' => 'Rule', ], ], ], 'DescribeSecurityProfileRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileId', 'InstanceId', ], 'members' => [ 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeSecurityProfileResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityProfile' => [ 'shape' => 'SecurityProfile', ], ], ], 'DescribeTrafficDistributionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], ], ], 'DescribeTrafficDistributionGroupResponse' => [ 'type' => 'structure', 'members' => [ 'TrafficDistributionGroup' => [ 'shape' => 'TrafficDistributionGroup', ], ], ], 'DescribeUserHierarchyGroupRequest' => [ 'type' => 'structure', 'required' => [ 'HierarchyGroupId', 'InstanceId', ], 'members' => [ 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', 'location' => 'uri', 'locationName' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeUserHierarchyGroupResponse' => [ 'type' => 'structure', 'members' => [ 'HierarchyGroup' => [ 'shape' => 'HierarchyGroup', ], ], ], 'DescribeUserHierarchyStructureRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeUserHierarchyStructureResponse' => [ 'type' => 'structure', 'members' => [ 'HierarchyStructure' => [ 'shape' => 'HierarchyStructure', ], ], ], 'DescribeUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserId', 'InstanceId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'User', ], ], ], 'DescribeViewRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], ], ], 'DescribeViewResponse' => [ 'type' => 'structure', 'members' => [ 'View' => [ 'shape' => 'View', ], ], ], 'DescribeVocabularyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'VocabularyId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', 'location' => 'uri', 'locationName' => 'VocabularyId', ], ], ], 'DescribeVocabularyResponse' => [ 'type' => 'structure', 'required' => [ 'Vocabulary', ], 'members' => [ 'Vocabulary' => [ 'shape' => 'Vocabulary', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, 'sensitive' => true, ], 'Description250' => [ 'type' => 'string', 'max' => 250, 'min' => 1, 'pattern' => '(^[\\S].*[\\S]$)|(^[\\S]$)', ], 'DestinationId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'DestinationNotAllowedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'DeviceInfo' => [ 'type' => 'structure', 'members' => [ 'PlatformName' => [ 'shape' => 'PlatformName', ], 'PlatformVersion' => [ 'shape' => 'PlatformVersion', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], ], ], 'Dimensions' => [ 'type' => 'structure', 'members' => [ 'Queue' => [ 'shape' => 'QueueReference', ], 'Channel' => [ 'shape' => 'Channel', ], 'RoutingProfile' => [ 'shape' => 'RoutingProfileReference', ], 'RoutingStepExpression' => [ 'shape' => 'RoutingExpression', ], ], ], 'DimensionsV2Key' => [ 'type' => 'string', ], 'DimensionsV2Map' => [ 'type' => 'map', 'key' => [ 'shape' => 'DimensionsV2Key', ], 'value' => [ 'shape' => 'DimensionsV2Value', ], ], 'DimensionsV2Value' => [ 'type' => 'string', ], 'DirectoryAlias' => [ 'type' => 'string', 'max' => 45, 'min' => 1, 'pattern' => '^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$', 'sensitive' => true, ], 'DirectoryId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^d-[0-9a-f]{10}$', ], 'DirectoryType' => [ 'type' => 'string', 'enum' => [ 'SAML', 'CONNECT_MANAGED', 'EXISTING_DIRECTORY', ], ], 'DirectoryUserId' => [ 'type' => 'string', ], 'DisassociateAnalyticsDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'DataSetId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetId' => [ 'shape' => 'DataSetId', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'DisassociateApprovedOriginRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Origin', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Origin' => [ 'shape' => 'Origin', 'location' => 'querystring', 'locationName' => 'origin', ], ], ], 'DisassociateBotRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LexBot' => [ 'shape' => 'LexBot', ], 'LexV2Bot' => [ 'shape' => 'LexV2Bot', ], ], ], 'DisassociateFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceId' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'FlowAssociationResourceType', 'location' => 'uri', 'locationName' => 'ResourceType', ], ], ], 'DisassociateFlowResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateInstanceStorageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AssociationId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociationId' => [ 'shape' => 'AssociationId', 'location' => 'uri', 'locationName' => 'AssociationId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', 'location' => 'querystring', 'locationName' => 'resourceType', ], ], ], 'DisassociateLambdaFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FunctionArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FunctionArn' => [ 'shape' => 'FunctionArn', 'location' => 'querystring', 'locationName' => 'functionArn', ], ], ], 'DisassociateLexBotRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'BotName', 'LexRegion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'BotName' => [ 'shape' => 'BotName', 'location' => 'querystring', 'locationName' => 'botName', ], 'LexRegion' => [ 'shape' => 'LexRegion', 'location' => 'querystring', 'locationName' => 'lexRegion', ], ], ], 'DisassociatePhoneNumberContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', 'InstanceId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'querystring', 'locationName' => 'instanceId', ], ], ], 'DisassociateQueueQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'QuickConnectIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'QuickConnectIds' => [ 'shape' => 'QuickConnectsList', ], ], ], 'DisassociateRoutingProfileQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'QueueReferences', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'QueueReferences' => [ 'shape' => 'RoutingProfileQueueReferenceList', ], ], ], 'DisassociateSecurityKeyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AssociationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociationId' => [ 'shape' => 'AssociationId', 'location' => 'uri', 'locationName' => 'AssociationId', ], ], ], 'DisassociateTrafficDistributionGroupUserRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', 'UserId', 'InstanceId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'querystring', 'locationName' => 'InstanceId', ], ], ], 'DisassociateTrafficDistributionGroupUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateUserProficienciesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', 'UserProficiencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'UserProficiencies' => [ 'shape' => 'UserProficiencyDisassociateList', ], ], ], 'DisconnectDetails' => [ 'type' => 'structure', 'members' => [ 'PotentialDisconnectIssue' => [ 'shape' => 'PotentialDisconnectIssue', ], ], ], 'DisconnectReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'DisconnectReasonCode', ], ], ], 'DisconnectReasonCode' => [ 'type' => 'string', ], 'DismissUserContactRequest' => [ 'type' => 'structure', 'required' => [ 'UserId', 'InstanceId', 'ContactId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], ], ], 'DismissUserContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisplayName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Distribution' => [ 'type' => 'structure', 'required' => [ 'Region', 'Percentage', ], 'members' => [ 'Region' => [ 'shape' => 'AwsRegion', ], 'Percentage' => [ 'shape' => 'Percentage', ], ], ], 'DistributionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Distribution', ], ], 'Double' => [ 'type' => 'double', ], 'DownloadUrlMetadata' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'MetadataUrl', ], 'UrlExpiry' => [ 'shape' => 'ISO8601Datetime', ], ], ], 'DuplicateResourceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DurationInSeconds' => [ 'type' => 'integer', ], 'Email' => [ 'type' => 'string', 'sensitive' => true, ], 'EmailReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'EmptyFieldValue' => [ 'type' => 'structure', 'members' => [], ], 'EncryptionConfig' => [ 'type' => 'structure', 'required' => [ 'EncryptionType', 'KeyId', ], 'members' => [ 'EncryptionType' => [ 'shape' => 'EncryptionType', ], 'KeyId' => [ 'shape' => 'KeyId', ], ], ], 'EncryptionType' => [ 'type' => 'string', 'enum' => [ 'KMS', ], ], 'EndAssociatedTasksActionDefinition' => [ 'type' => 'structure', 'members' => [], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'EndpointType', ], 'Address' => [ 'shape' => 'EndpointAddress', ], ], ], 'EndpointAddress' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'EndpointType' => [ 'type' => 'string', 'enum' => [ 'TELEPHONE_NUMBER', 'VOIP', 'CONTACT_FLOW', ], ], 'ErrorCode' => [ 'type' => 'string', ], 'ErrorMessage' => [ 'type' => 'string', ], 'ErrorResult' => [ 'type' => 'structure', 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'ErrorResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'ErrorResult', ], ], 'Evaluation' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', 'Metadata', 'Answers', 'Notes', 'Status', 'CreatedTime', 'LastModifiedTime', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], 'Metadata' => [ 'shape' => 'EvaluationMetadata', ], 'Answers' => [ 'shape' => 'EvaluationAnswersOutputMap', ], 'Notes' => [ 'shape' => 'EvaluationNotesMap', ], 'Status' => [ 'shape' => 'EvaluationStatus', ], 'Scores' => [ 'shape' => 'EvaluationScoresMap', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'EvaluationAnswerData' => [ 'type' => 'structure', 'members' => [ 'StringValue' => [ 'shape' => 'EvaluationAnswerDataStringValue', ], 'NumericValue' => [ 'shape' => 'EvaluationAnswerDataNumericValue', ], 'NotApplicable' => [ 'shape' => 'Boolean', ], ], 'union' => true, ], 'EvaluationAnswerDataNumericValue' => [ 'type' => 'double', ], 'EvaluationAnswerDataStringValue' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'EvaluationAnswerInput' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'EvaluationAnswerData', ], ], ], 'EvaluationAnswerOutput' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'EvaluationAnswerData', ], 'SystemSuggestedValue' => [ 'shape' => 'EvaluationAnswerData', ], ], ], 'EvaluationAnswersInputMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceId', ], 'value' => [ 'shape' => 'EvaluationAnswerInput', ], 'max' => 100, ], 'EvaluationAnswersOutputMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceId', ], 'value' => [ 'shape' => 'EvaluationAnswerOutput', ], 'max' => 100, ], 'EvaluationForm' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormVersion', 'Locked', 'EvaluationFormArn', 'Title', 'Status', 'Items', 'CreatedTime', 'CreatedBy', 'LastModifiedTime', 'LastModifiedBy', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], 'Locked' => [ 'shape' => 'EvaluationFormVersionIsLocked', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'Description' => [ 'shape' => 'EvaluationFormDescription', ], 'Status' => [ 'shape' => 'EvaluationFormVersionStatus', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'ScoringStrategy' => [ 'shape' => 'EvaluationFormScoringStrategy', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'ARN', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'ARN', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'EvaluationFormContent' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormVersion', 'EvaluationFormId', 'EvaluationFormArn', 'Title', 'Items', ], 'members' => [ 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'Description' => [ 'shape' => 'EvaluationFormDescription', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'ScoringStrategy' => [ 'shape' => 'EvaluationFormScoringStrategy', ], ], ], 'EvaluationFormDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'EvaluationFormId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'EvaluationFormItem' => [ 'type' => 'structure', 'members' => [ 'Section' => [ 'shape' => 'EvaluationFormSection', ], 'Question' => [ 'shape' => 'EvaluationFormQuestion', ], ], 'union' => true, ], 'EvaluationFormItemWeight' => [ 'type' => 'double', 'max' => 100, 'min' => 0, ], 'EvaluationFormItemsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormItem', ], 'max' => 100, 'min' => 1, ], 'EvaluationFormNumericQuestionAutomation' => [ 'type' => 'structure', 'members' => [ 'PropertyValue' => [ 'shape' => 'NumericQuestionPropertyValueAutomation', ], ], 'union' => true, ], 'EvaluationFormNumericQuestionOption' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'Integer', ], 'MaxValue' => [ 'shape' => 'Integer', ], 'Score' => [ 'shape' => 'EvaluationFormQuestionAnswerScore', ], 'AutomaticFail' => [ 'shape' => 'Boolean', ], ], ], 'EvaluationFormNumericQuestionOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormNumericQuestionOption', ], 'max' => 10, 'min' => 1, ], 'EvaluationFormNumericQuestionProperties' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'Integer', ], 'MaxValue' => [ 'shape' => 'Integer', ], 'Options' => [ 'shape' => 'EvaluationFormNumericQuestionOptionList', ], 'Automation' => [ 'shape' => 'EvaluationFormNumericQuestionAutomation', ], ], ], 'EvaluationFormQuestion' => [ 'type' => 'structure', 'required' => [ 'Title', 'RefId', 'QuestionType', ], 'members' => [ 'Title' => [ 'shape' => 'EvaluationFormQuestionTitle', ], 'Instructions' => [ 'shape' => 'EvaluationFormQuestionInstructions', ], 'RefId' => [ 'shape' => 'ReferenceId', ], 'NotApplicableEnabled' => [ 'shape' => 'Boolean', ], 'QuestionType' => [ 'shape' => 'EvaluationFormQuestionType', ], 'QuestionTypeProperties' => [ 'shape' => 'EvaluationFormQuestionTypeProperties', ], 'Weight' => [ 'shape' => 'EvaluationFormItemWeight', ], ], ], 'EvaluationFormQuestionAnswerScore' => [ 'type' => 'integer', 'max' => 10, 'min' => 0, ], 'EvaluationFormQuestionInstructions' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'EvaluationFormQuestionTitle' => [ 'type' => 'string', 'max' => 350, 'min' => 0, ], 'EvaluationFormQuestionType' => [ 'type' => 'string', 'enum' => [ 'TEXT', 'SINGLESELECT', 'NUMERIC', ], ], 'EvaluationFormQuestionTypeProperties' => [ 'type' => 'structure', 'members' => [ 'Numeric' => [ 'shape' => 'EvaluationFormNumericQuestionProperties', ], 'SingleSelect' => [ 'shape' => 'EvaluationFormSingleSelectQuestionProperties', ], ], 'union' => true, ], 'EvaluationFormScoringMode' => [ 'type' => 'string', 'enum' => [ 'QUESTION_ONLY', 'SECTION_ONLY', ], ], 'EvaluationFormScoringStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'EvaluationFormScoringStrategy' => [ 'type' => 'structure', 'required' => [ 'Mode', 'Status', ], 'members' => [ 'Mode' => [ 'shape' => 'EvaluationFormScoringMode', ], 'Status' => [ 'shape' => 'EvaluationFormScoringStatus', ], ], ], 'EvaluationFormSection' => [ 'type' => 'structure', 'required' => [ 'Title', 'RefId', 'Items', ], 'members' => [ 'Title' => [ 'shape' => 'EvaluationFormSectionTitle', ], 'RefId' => [ 'shape' => 'ReferenceId', ], 'Instructions' => [ 'shape' => 'EvaluationFormQuestionInstructions', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'Weight' => [ 'shape' => 'EvaluationFormItemWeight', ], ], ], 'EvaluationFormSectionTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'EvaluationFormSingleSelectQuestionAutomation' => [ 'type' => 'structure', 'required' => [ 'Options', ], 'members' => [ 'Options' => [ 'shape' => 'EvaluationFormSingleSelectQuestionAutomationOptionList', ], 'DefaultOptionRefId' => [ 'shape' => 'ReferenceId', ], ], ], 'EvaluationFormSingleSelectQuestionAutomationOption' => [ 'type' => 'structure', 'members' => [ 'RuleCategory' => [ 'shape' => 'SingleSelectQuestionRuleCategoryAutomation', ], ], 'union' => true, ], 'EvaluationFormSingleSelectQuestionAutomationOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormSingleSelectQuestionAutomationOption', ], 'max' => 20, 'min' => 1, ], 'EvaluationFormSingleSelectQuestionDisplayMode' => [ 'type' => 'string', 'enum' => [ 'DROPDOWN', 'RADIO', ], ], 'EvaluationFormSingleSelectQuestionOption' => [ 'type' => 'structure', 'required' => [ 'RefId', 'Text', ], 'members' => [ 'RefId' => [ 'shape' => 'ReferenceId', ], 'Text' => [ 'shape' => 'EvaluationFormSingleSelectQuestionOptionText', ], 'Score' => [ 'shape' => 'EvaluationFormQuestionAnswerScore', ], 'AutomaticFail' => [ 'shape' => 'Boolean', ], ], ], 'EvaluationFormSingleSelectQuestionOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormSingleSelectQuestionOption', ], 'max' => 256, 'min' => 1, ], 'EvaluationFormSingleSelectQuestionOptionText' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'EvaluationFormSingleSelectQuestionProperties' => [ 'type' => 'structure', 'required' => [ 'Options', ], 'members' => [ 'Options' => [ 'shape' => 'EvaluationFormSingleSelectQuestionOptionList', ], 'DisplayAs' => [ 'shape' => 'EvaluationFormSingleSelectQuestionDisplayMode', ], 'Automation' => [ 'shape' => 'EvaluationFormSingleSelectQuestionAutomation', ], ], ], 'EvaluationFormSummary' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', 'Title', 'CreatedTime', 'CreatedBy', 'LastModifiedTime', 'LastModifiedBy', 'LatestVersion', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'ARN', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'ARN', ], 'LastActivatedTime' => [ 'shape' => 'Timestamp', ], 'LastActivatedBy' => [ 'shape' => 'ARN', ], 'LatestVersion' => [ 'shape' => 'VersionNumber', ], 'ActiveVersion' => [ 'shape' => 'VersionNumber', 'box' => true, ], ], ], 'EvaluationFormSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormSummary', ], ], 'EvaluationFormTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'EvaluationFormVersionIsLocked' => [ 'type' => 'boolean', ], 'EvaluationFormVersionStatus' => [ 'type' => 'string', 'enum' => [ 'DRAFT', 'ACTIVE', ], ], 'EvaluationFormVersionSummary' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormArn', 'EvaluationFormId', 'EvaluationFormVersion', 'Locked', 'Status', 'CreatedTime', 'CreatedBy', 'LastModifiedTime', 'LastModifiedBy', ], 'members' => [ 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], 'Locked' => [ 'shape' => 'EvaluationFormVersionIsLocked', ], 'Status' => [ 'shape' => 'EvaluationFormVersionStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'ARN', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'ARN', ], ], ], 'EvaluationFormVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormVersionSummary', ], ], 'EvaluationMetadata' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'EvaluatorArn', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'EvaluatorArn' => [ 'shape' => 'ARN', ], 'ContactAgentId' => [ 'shape' => 'ResourceId', ], 'Score' => [ 'shape' => 'EvaluationScore', ], ], ], 'EvaluationNote' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'EvaluationNoteString', ], ], ], 'EvaluationNoteString' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, ], 'EvaluationNotesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceId', ], 'value' => [ 'shape' => 'EvaluationNote', ], 'max' => 100, ], 'EvaluationScore' => [ 'type' => 'structure', 'members' => [ 'Percentage' => [ 'shape' => 'EvaluationScorePercentage', ], 'NotApplicable' => [ 'shape' => 'Boolean', ], 'AutomaticFail' => [ 'shape' => 'Boolean', ], ], ], 'EvaluationScorePercentage' => [ 'type' => 'double', 'max' => 100, 'min' => 0, ], 'EvaluationScoresMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceId', ], 'value' => [ 'shape' => 'EvaluationScore', ], 'max' => 100, ], 'EvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'DRAFT', 'SUBMITTED', ], ], 'EvaluationSummary' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', 'EvaluationFormTitle', 'EvaluationFormId', 'Status', 'EvaluatorArn', 'CreatedTime', 'LastModifiedTime', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], 'EvaluationFormTitle' => [ 'shape' => 'EvaluationFormTitle', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'Status' => [ 'shape' => 'EvaluationStatus', ], 'EvaluatorArn' => [ 'shape' => 'ARN', ], 'Score' => [ 'shape' => 'EvaluationScore', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EvaluationSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationSummary', ], ], 'EventBridgeActionDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'EventBridgeActionName', ], ], ], 'EventBridgeActionName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'EventSourceName' => [ 'type' => 'string', 'enum' => [ 'OnPostCallAnalysisAvailable', 'OnRealTimeCallAnalysisAvailable', 'OnRealTimeChatAnalysisAvailable', 'OnPostChatAnalysisAvailable', 'OnZendeskTicketCreate', 'OnZendeskTicketStatusUpdate', 'OnSalesforceCaseCreate', 'OnContactEvaluationSubmit', 'OnMetricDataUpdate', 'OnCaseCreate', 'OnCaseUpdate', ], ], 'Expiry' => [ 'type' => 'structure', 'members' => [ 'DurationInSeconds' => [ 'shape' => 'DurationInSeconds', ], 'ExpiryTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'Expression' => [ 'type' => 'structure', 'members' => [ 'AttributeCondition' => [ 'shape' => 'AttributeCondition', ], 'AndExpression' => [ 'shape' => 'Expressions', ], 'OrExpression' => [ 'shape' => 'Expressions', ], ], ], 'Expressions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Expression', ], ], 'FailedRequest' => [ 'type' => 'structure', 'members' => [ 'RequestIdentifier' => [ 'shape' => 'RequestIdentifier', ], 'FailureReasonCode' => [ 'shape' => 'FailureReasonCode', ], 'FailureReasonMessage' => [ 'shape' => 'String', ], ], ], 'FailedRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedRequest', ], ], 'FailureReasonCode' => [ 'type' => 'string', 'enum' => [ 'INVALID_ATTRIBUTE_KEY', 'INVALID_CUSTOMER_ENDPOINT', 'INVALID_SYSTEM_ENDPOINT', 'INVALID_QUEUE', 'MISSING_CAMPAIGN', 'MISSING_CUSTOMER_ENDPOINT', 'MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT', 'REQUEST_THROTTLED', 'IDEMPOTENCY_EXCEPTION', 'INTERNAL_ERROR', ], ], 'FieldStringValue' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'FieldValue' => [ 'type' => 'structure', 'required' => [ 'Id', 'Value', ], 'members' => [ 'Id' => [ 'shape' => 'FieldValueId', ], 'Value' => [ 'shape' => 'FieldValueUnion', ], ], ], 'FieldValueId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'FieldValueUnion' => [ 'type' => 'structure', 'members' => [ 'BooleanValue' => [ 'shape' => 'Boolean', ], 'DoubleValue' => [ 'shape' => 'Double', ], 'EmptyValue' => [ 'shape' => 'EmptyFieldValue', ], 'StringValue' => [ 'shape' => 'FieldStringValue', ], ], ], 'FieldValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldValue', ], ], 'FileId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'FileIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FileId', ], 'min' => 1, ], 'FileName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^\\P{C}*$', ], 'FileSizeInBytes' => [ 'type' => 'long', 'box' => true, 'min' => 1, ], 'FileStatusType' => [ 'type' => 'string', 'enum' => [ 'APPROVED', 'REJECTED', 'PROCESSING', 'FAILED', ], ], 'FileUseCaseType' => [ 'type' => 'string', 'enum' => [ 'ATTACHMENT', ], ], 'FilterV2' => [ 'type' => 'structure', 'members' => [ 'FilterKey' => [ 'shape' => 'ResourceArnOrId', ], 'FilterValues' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceArnOrId', ], 'max' => 100, 'min' => 1, ], 'Filters' => [ 'type' => 'structure', 'members' => [ 'Queues' => [ 'shape' => 'Queues', ], 'Channels' => [ 'shape' => 'Channels', ], 'RoutingProfiles' => [ 'shape' => 'RoutingProfiles', ], 'RoutingStepExpressions' => [ 'shape' => 'RoutingExpressions', ], ], ], 'FiltersV2List' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterV2', ], 'max' => 5, 'min' => 1, ], 'FlowAssociationResourceType' => [ 'type' => 'string', 'enum' => [ 'SMS_PHONE_NUMBER', ], ], 'FlowAssociationSummary' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ARN', ], 'FlowId' => [ 'shape' => 'ARN', ], 'ResourceType' => [ 'shape' => 'ListFlowAssociationResourceType', ], ], ], 'FlowAssociationSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowAssociationSummary', ], ], 'FunctionArn' => [ 'type' => 'string', 'max' => 140, 'min' => 1, ], 'FunctionArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FunctionArn', ], ], 'GetAttachedFileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FileId', 'AssociatedResourceArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FileId' => [ 'shape' => 'FileId', 'location' => 'uri', 'locationName' => 'FileId', ], 'UrlExpiryInSeconds' => [ 'shape' => 'URLExpiryInSeconds', 'location' => 'querystring', 'locationName' => 'urlExpiryInSeconds', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], ], ], 'GetAttachedFileResponse' => [ 'type' => 'structure', 'required' => [ 'FileSizeInBytes', ], 'members' => [ 'FileArn' => [ 'shape' => 'ARN', ], 'FileId' => [ 'shape' => 'FileId', ], 'CreationTime' => [ 'shape' => 'ISO8601Datetime', ], 'FileStatus' => [ 'shape' => 'FileStatusType', ], 'FileName' => [ 'shape' => 'FileName', ], 'FileSizeInBytes' => [ 'shape' => 'FileSizeInBytes', 'box' => true, ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', ], 'FileUseCaseType' => [ 'shape' => 'FileUseCaseType', ], 'CreatedBy' => [ 'shape' => 'CreatedByInfo', ], 'DownloadUrlMetadata' => [ 'shape' => 'DownloadUrlMetadata', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'GetContactAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'InitialContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'InitialContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'InitialContactId', ], ], ], 'GetContactAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'Attributes' => [ 'shape' => 'Attributes', ], ], ], 'GetCurrentMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Filters', 'CurrentMetrics', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Filters' => [ 'shape' => 'Filters', ], 'Groupings' => [ 'shape' => 'Groupings', ], 'CurrentMetrics' => [ 'shape' => 'CurrentMetrics', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SortCriteria' => [ 'shape' => 'CurrentMetricSortCriteriaMaxOne', ], ], ], 'GetCurrentMetricDataResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MetricResults' => [ 'shape' => 'CurrentMetricResults', ], 'DataSnapshotTime' => [ 'shape' => 'timestamp', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'GetCurrentUserDataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Filters', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Filters' => [ 'shape' => 'UserDataFilters', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], ], ], 'GetCurrentUserDataResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'UserDataList' => [ 'shape' => 'UserDataList', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'GetFederationTokenRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'GetFederationTokenResponse' => [ 'type' => 'structure', 'members' => [ 'Credentials' => [ 'shape' => 'Credentials', ], 'SignInUrl' => [ 'shape' => 'Url', ], 'UserArn' => [ 'shape' => 'ARN', ], 'UserId' => [ 'shape' => 'AgentResourceId', ], ], ], 'GetFlowAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceId' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'FlowAssociationResourceType', 'location' => 'uri', 'locationName' => 'ResourceType', ], ], ], 'GetFlowAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ARN', ], 'FlowId' => [ 'shape' => 'ARN', ], 'ResourceType' => [ 'shape' => 'FlowAssociationResourceType', ], ], ], 'GetMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'StartTime', 'EndTime', 'Filters', 'HistoricalMetrics', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'StartTime' => [ 'shape' => 'timestamp', ], 'EndTime' => [ 'shape' => 'timestamp', ], 'Filters' => [ 'shape' => 'Filters', ], 'Groupings' => [ 'shape' => 'Groupings', ], 'HistoricalMetrics' => [ 'shape' => 'HistoricalMetrics', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], ], ], 'GetMetricDataResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MetricResults' => [ 'shape' => 'HistoricalMetricResults', ], ], ], 'GetMetricDataV2Request' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'StartTime', 'EndTime', 'Filters', 'Metrics', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ARN', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Interval' => [ 'shape' => 'IntervalDetails', ], 'Filters' => [ 'shape' => 'FiltersV2List', ], 'Groupings' => [ 'shape' => 'GroupingsV2', ], 'Metrics' => [ 'shape' => 'MetricsV2', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], ], ], 'GetMetricDataV2Response' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MetricResults' => [ 'shape' => 'MetricResultsV2', ], ], ], 'GetPromptFileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'PromptId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PromptId' => [ 'shape' => 'PromptId', 'location' => 'uri', 'locationName' => 'PromptId', ], ], ], 'GetPromptFileResponse' => [ 'type' => 'structure', 'members' => [ 'PromptPresignedUrl' => [ 'shape' => 'PromptPresignedUrl', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'GetTaskTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'TaskTemplateId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'TaskTemplateId' => [ 'shape' => 'TaskTemplateId', 'location' => 'uri', 'locationName' => 'TaskTemplateId', ], 'SnapshotVersion' => [ 'shape' => 'SnapshotVersion', 'location' => 'querystring', 'locationName' => 'snapshotVersion', ], ], ], 'GetTaskTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'Id', 'Arn', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Id' => [ 'shape' => 'TaskTemplateId', ], 'Arn' => [ 'shape' => 'TaskTemplateArn', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Constraints' => [ 'shape' => 'TaskTemplateConstraints', ], 'Defaults' => [ 'shape' => 'TaskTemplateDefaults', ], 'Fields' => [ 'shape' => 'TaskTemplateFields', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'LastModifiedTime' => [ 'shape' => 'timestamp', ], 'CreatedTime' => [ 'shape' => 'timestamp', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'GetTrafficDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'Id', ], ], ], 'GetTrafficDistributionResponse' => [ 'type' => 'structure', 'members' => [ 'TelephonyConfig' => [ 'shape' => 'TelephonyConfig', ], 'Id' => [ 'shape' => 'TrafficDistributionGroupId', ], 'Arn' => [ 'shape' => 'TrafficDistributionGroupArn', ], 'SignInConfig' => [ 'shape' => 'SignInConfig', ], 'AgentConfig' => [ 'shape' => 'AgentConfig', ], ], ], 'Grouping' => [ 'type' => 'string', 'enum' => [ 'QUEUE', 'CHANNEL', 'ROUTING_PROFILE', 'ROUTING_STEP_EXPRESSION', ], ], 'GroupingV2' => [ 'type' => 'string', ], 'Groupings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Grouping', ], 'max' => 2, ], 'GroupingsV2' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupingV2', ], 'max' => 3, ], 'HierarchyGroup' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HierarchyGroupId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'HierarchyGroupName', ], 'LevelId' => [ 'shape' => 'HierarchyLevelId', ], 'HierarchyPath' => [ 'shape' => 'HierarchyPath', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HierarchyGroupCondition' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'String', ], 'HierarchyGroupMatchType' => [ 'shape' => 'HierarchyGroupMatchType', ], ], ], 'HierarchyGroupId' => [ 'type' => 'string', ], 'HierarchyGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HierarchyGroupId', ], 'max' => 10, 'min' => 0, ], 'HierarchyGroupMatchType' => [ 'type' => 'string', 'enum' => [ 'EXACT', 'WITH_CHILD_GROUPS', ], ], 'HierarchyGroupName' => [ 'type' => 'string', ], 'HierarchyGroupSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HierarchyGroupId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'HierarchyGroupName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HierarchyGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HierarchyGroupSummary', ], ], 'HierarchyGroupSummaryReference' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HierarchyGroupId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'HierarchyGroups' => [ 'type' => 'structure', 'members' => [ 'Level1' => [ 'shape' => 'AgentHierarchyGroup', ], 'Level2' => [ 'shape' => 'AgentHierarchyGroup', ], 'Level3' => [ 'shape' => 'AgentHierarchyGroup', ], 'Level4' => [ 'shape' => 'AgentHierarchyGroup', ], 'Level5' => [ 'shape' => 'AgentHierarchyGroup', ], ], ], 'HierarchyLevel' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HierarchyLevelId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'HierarchyLevelName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HierarchyLevelId' => [ 'type' => 'string', ], 'HierarchyLevelName' => [ 'type' => 'string', ], 'HierarchyLevelUpdate' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'HierarchyLevelName', ], ], ], 'HierarchyPath' => [ 'type' => 'structure', 'members' => [ 'LevelOne' => [ 'shape' => 'HierarchyGroupSummary', ], 'LevelTwo' => [ 'shape' => 'HierarchyGroupSummary', ], 'LevelThree' => [ 'shape' => 'HierarchyGroupSummary', ], 'LevelFour' => [ 'shape' => 'HierarchyGroupSummary', ], 'LevelFive' => [ 'shape' => 'HierarchyGroupSummary', ], ], ], 'HierarchyPathReference' => [ 'type' => 'structure', 'members' => [ 'LevelOne' => [ 'shape' => 'HierarchyGroupSummaryReference', ], 'LevelTwo' => [ 'shape' => 'HierarchyGroupSummaryReference', ], 'LevelThree' => [ 'shape' => 'HierarchyGroupSummaryReference', ], 'LevelFour' => [ 'shape' => 'HierarchyGroupSummaryReference', ], 'LevelFive' => [ 'shape' => 'HierarchyGroupSummaryReference', ], ], ], 'HierarchyRestrictedResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HierarchyRestrictedResourceName', ], ], 'HierarchyRestrictedResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'HierarchyStructure' => [ 'type' => 'structure', 'members' => [ 'LevelOne' => [ 'shape' => 'HierarchyLevel', ], 'LevelTwo' => [ 'shape' => 'HierarchyLevel', ], 'LevelThree' => [ 'shape' => 'HierarchyLevel', ], 'LevelFour' => [ 'shape' => 'HierarchyLevel', ], 'LevelFive' => [ 'shape' => 'HierarchyLevel', ], ], ], 'HierarchyStructureUpdate' => [ 'type' => 'structure', 'members' => [ 'LevelOne' => [ 'shape' => 'HierarchyLevelUpdate', ], 'LevelTwo' => [ 'shape' => 'HierarchyLevelUpdate', ], 'LevelThree' => [ 'shape' => 'HierarchyLevelUpdate', ], 'LevelFour' => [ 'shape' => 'HierarchyLevelUpdate', ], 'LevelFive' => [ 'shape' => 'HierarchyLevelUpdate', ], ], ], 'HistoricalMetric' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'HistoricalMetricName', ], 'Threshold' => [ 'shape' => 'Threshold', 'box' => true, ], 'Statistic' => [ 'shape' => 'Statistic', ], 'Unit' => [ 'shape' => 'Unit', ], ], ], 'HistoricalMetricData' => [ 'type' => 'structure', 'members' => [ 'Metric' => [ 'shape' => 'HistoricalMetric', ], 'Value' => [ 'shape' => 'Value', 'box' => true, ], ], ], 'HistoricalMetricDataCollections' => [ 'type' => 'list', 'member' => [ 'shape' => 'HistoricalMetricData', ], ], 'HistoricalMetricName' => [ 'type' => 'string', 'enum' => [ 'CONTACTS_QUEUED', 'CONTACTS_HANDLED', 'CONTACTS_ABANDONED', 'CONTACTS_CONSULTED', 'CONTACTS_AGENT_HUNG_UP_FIRST', 'CONTACTS_HANDLED_INCOMING', 'CONTACTS_HANDLED_OUTBOUND', 'CONTACTS_HOLD_ABANDONS', 'CONTACTS_TRANSFERRED_IN', 'CONTACTS_TRANSFERRED_OUT', 'CONTACTS_TRANSFERRED_IN_FROM_QUEUE', 'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE', 'CONTACTS_MISSED', 'CALLBACK_CONTACTS_HANDLED', 'API_CONTACTS_HANDLED', 'OCCUPANCY', 'HANDLE_TIME', 'AFTER_CONTACT_WORK_TIME', 'QUEUED_TIME', 'ABANDON_TIME', 'QUEUE_ANSWER_TIME', 'HOLD_TIME', 'INTERACTION_TIME', 'INTERACTION_AND_HOLD_TIME', 'SERVICE_LEVEL', ], ], 'HistoricalMetricResult' => [ 'type' => 'structure', 'members' => [ 'Dimensions' => [ 'shape' => 'Dimensions', ], 'Collections' => [ 'shape' => 'HistoricalMetricDataCollections', ], ], ], 'HistoricalMetricResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'HistoricalMetricResult', ], ], 'HistoricalMetrics' => [ 'type' => 'list', 'member' => [ 'shape' => 'HistoricalMetric', ], ], 'Hours' => [ 'type' => 'integer', 'max' => 87600, 'min' => 0, ], 'Hours24Format' => [ 'type' => 'integer', 'max' => 23, 'min' => 0, ], 'HoursOfOperation' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], 'HoursOfOperationArn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'HoursOfOperationDescription', ], 'TimeZone' => [ 'shape' => 'TimeZone', ], 'Config' => [ 'shape' => 'HoursOfOperationConfigList', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HoursOfOperationConfig' => [ 'type' => 'structure', 'required' => [ 'Day', 'StartTime', 'EndTime', ], 'members' => [ 'Day' => [ 'shape' => 'HoursOfOperationDays', ], 'StartTime' => [ 'shape' => 'HoursOfOperationTimeSlice', ], 'EndTime' => [ 'shape' => 'HoursOfOperationTimeSlice', ], ], ], 'HoursOfOperationConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HoursOfOperationConfig', ], 'max' => 100, 'min' => 0, ], 'HoursOfOperationDays' => [ 'type' => 'string', 'enum' => [ 'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', ], ], 'HoursOfOperationDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'HoursOfOperationId' => [ 'type' => 'string', ], 'HoursOfOperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HoursOfOperation', ], ], 'HoursOfOperationName' => [ 'type' => 'string', ], 'HoursOfOperationSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HoursOfOperationSearchCriteria', ], ], 'HoursOfOperationSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'HoursOfOperationSearchConditionList', ], 'AndConditions' => [ 'shape' => 'HoursOfOperationSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'HoursOfOperationSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'HoursOfOperationSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HoursOfOperationId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'HoursOfOperationName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HoursOfOperationSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HoursOfOperationSummary', ], ], 'HoursOfOperationTimeSlice' => [ 'type' => 'structure', 'required' => [ 'Hours', 'Minutes', ], 'members' => [ 'Hours' => [ 'shape' => 'Hours24Format', 'box' => true, ], 'Minutes' => [ 'shape' => 'MinutesLimit60', 'box' => true, ], ], ], 'ISO8601Datetime' => [ 'type' => 'string', ], 'IdempotencyException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ImportPhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'SourcePhoneNumberArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'SourcePhoneNumberArn' => [ 'shape' => 'ARN', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'ImportPhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'InboundCallsEnabled' => [ 'type' => 'boolean', ], 'Index' => [ 'type' => 'integer', ], 'InitiationMethodList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactInitiationMethod', ], ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], 'IdentityManagementType' => [ 'shape' => 'DirectoryType', ], 'InstanceAlias' => [ 'shape' => 'DirectoryAlias', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'ServiceRole' => [ 'shape' => 'ARN', ], 'InstanceStatus' => [ 'shape' => 'InstanceStatus', ], 'StatusReason' => [ 'shape' => 'InstanceStatusReason', ], 'InboundCallsEnabled' => [ 'shape' => 'InboundCallsEnabled', ], 'OutboundCallsEnabled' => [ 'shape' => 'OutboundCallsEnabled', ], 'InstanceAccessUrl' => [ 'shape' => 'Url', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'InstanceArn' => [ 'type' => 'string', 'pattern' => 'arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}', ], 'InstanceAttributeType' => [ 'type' => 'string', 'enum' => [ 'INBOUND_CALLS', 'OUTBOUND_CALLS', 'CONTACTFLOW_LOGS', 'CONTACT_LENS', 'AUTO_RESOLVE_BEST_VOICES', 'USE_CUSTOM_TTS_VOICES', 'EARLY_MEDIA', 'MULTI_PARTY_CONFERENCE', 'HIGH_VOLUME_OUTBOUND', 'ENHANCED_CONTACT_MONITORING', 'ENHANCED_CHAT_MONITORING', ], ], 'InstanceAttributeValue' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'InstanceId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'InstanceIdOrArn' => [ 'type' => 'string', 'max' => 250, 'min' => 1, 'pattern' => '^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'InstanceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'ACTIVE', 'CREATION_FAILED', ], ], 'InstanceStatusReason' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'InstanceStorageConfig' => [ 'type' => 'structure', 'required' => [ 'StorageType', ], 'members' => [ 'AssociationId' => [ 'shape' => 'AssociationId', ], 'StorageType' => [ 'shape' => 'StorageType', ], 'S3Config' => [ 'shape' => 'S3Config', ], 'KinesisVideoStreamConfig' => [ 'shape' => 'KinesisVideoStreamConfig', ], 'KinesisStreamConfig' => [ 'shape' => 'KinesisStreamConfig', ], 'KinesisFirehoseConfig' => [ 'shape' => 'KinesisFirehoseConfig', ], ], ], 'InstanceStorageConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceStorageConfig', ], ], 'InstanceStorageResourceType' => [ 'type' => 'string', 'enum' => [ 'CHAT_TRANSCRIPTS', 'CALL_RECORDINGS', 'SCHEDULED_REPORTS', 'MEDIA_STREAMS', 'CONTACT_TRACE_RECORDS', 'AGENT_EVENTS', 'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS', 'ATTACHMENTS', 'CONTACT_EVALUATIONS', 'SCREEN_RECORDINGS', 'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS', 'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS', ], ], 'InstanceSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], 'IdentityManagementType' => [ 'shape' => 'DirectoryType', ], 'InstanceAlias' => [ 'shape' => 'DirectoryAlias', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'ServiceRole' => [ 'shape' => 'ARN', ], 'InstanceStatus' => [ 'shape' => 'InstanceStatus', ], 'InboundCallsEnabled' => [ 'shape' => 'InboundCallsEnabled', ], 'OutboundCallsEnabled' => [ 'shape' => 'OutboundCallsEnabled', ], 'InstanceAccessUrl' => [ 'shape' => 'Url', ], ], ], 'InstanceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceSummary', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerCount' => [ 'type' => 'integer', 'min' => 0, ], 'IntegrationAssociationId' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'IntegrationAssociationSummary' => [ 'type' => 'structure', 'members' => [ 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', ], 'IntegrationAssociationArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'IntegrationType' => [ 'shape' => 'IntegrationType', ], 'IntegrationArn' => [ 'shape' => 'ARN', ], 'SourceApplicationUrl' => [ 'shape' => 'URI', ], 'SourceApplicationName' => [ 'shape' => 'SourceApplicationName', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'IntegrationAssociationSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegrationAssociationSummary', ], ], 'IntegrationType' => [ 'type' => 'string', 'enum' => [ 'EVENT', 'VOICE_ID', 'PINPOINT_APP', 'WISDOM_ASSISTANT', 'WISDOM_KNOWLEDGE_BASE', 'WISDOM_QUICK_RESPONSES', 'CASES_DOMAIN', 'APPLICATION', 'FILE_SCANNER', ], ], 'InternalServiceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'IntervalDetails' => [ 'type' => 'structure', 'members' => [ 'TimeZone' => [ 'shape' => 'String', ], 'IntervalPeriod' => [ 'shape' => 'IntervalPeriod', ], ], ], 'IntervalPeriod' => [ 'type' => 'string', 'enum' => [ 'FIFTEEN_MIN', 'THIRTY_MIN', 'HOUR', 'DAY', 'WEEK', 'TOTAL', ], ], 'InvalidContactFlowException' => [ 'type' => 'structure', 'members' => [ 'problems' => [ 'shape' => 'Problems', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidContactFlowModuleException' => [ 'type' => 'structure', 'members' => [ 'Problems' => [ 'shape' => 'Problems', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], 'Reason' => [ 'shape' => 'InvalidRequestExceptionReason', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidRequestExceptionReason' => [ 'type' => 'structure', 'members' => [ 'AttachedFileInvalidRequestExceptionReason' => [ 'shape' => 'AttachedFileInvalidRequestExceptionReason', ], ], 'union' => true, ], 'InvisibleFieldInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], ], ], 'InvisibleTaskTemplateFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'InvisibleFieldInfo', ], ], 'JoinToken' => [ 'type' => 'string', 'sensitive' => true, ], 'KeyId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'KinesisFirehoseConfig' => [ 'type' => 'structure', 'required' => [ 'FirehoseArn', ], 'members' => [ 'FirehoseArn' => [ 'shape' => 'ARN', ], ], ], 'KinesisStreamConfig' => [ 'type' => 'structure', 'required' => [ 'StreamArn', ], 'members' => [ 'StreamArn' => [ 'shape' => 'ARN', ], ], ], 'KinesisVideoStreamConfig' => [ 'type' => 'structure', 'required' => [ 'Prefix', 'RetentionPeriodHours', 'EncryptionConfig', ], 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'RetentionPeriodHours' => [ 'shape' => 'Hours', ], 'EncryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'LargeNextToken' => [ 'type' => 'string', 'max' => 100000, 'min' => 1, ], 'LexBot' => [ 'type' => 'structure', 'required' => [ 'Name', 'LexRegion', ], 'members' => [ 'Name' => [ 'shape' => 'BotName', ], 'LexRegion' => [ 'shape' => 'LexRegion', ], ], ], 'LexBotConfig' => [ 'type' => 'structure', 'members' => [ 'LexBot' => [ 'shape' => 'LexBot', ], 'LexV2Bot' => [ 'shape' => 'LexV2Bot', ], ], ], 'LexBotConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LexBotConfig', ], ], 'LexBotsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LexBot', ], ], 'LexRegion' => [ 'type' => 'string', 'max' => 60, ], 'LexV2Bot' => [ 'type' => 'structure', 'members' => [ 'AliasArn' => [ 'shape' => 'AliasArn', ], ], ], 'LexVersion' => [ 'type' => 'string', 'enum' => [ 'V1', 'V2', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'ListAgentStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'AgentStatusTypes' => [ 'shape' => 'AgentStatusTypes', 'location' => 'querystring', 'locationName' => 'AgentStatusTypes', ], ], ], 'ListAgentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'AgentStatusSummaryList' => [ 'shape' => 'AgentStatusSummaryList', ], ], ], 'ListAnalyticsDataAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetId' => [ 'shape' => 'DataSetId', 'location' => 'querystring', 'locationName' => 'DataSetId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListAnalyticsDataAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'AnalyticsDataAssociationResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApprovedOriginsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult25', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListApprovedOriginsResponse' => [ 'type' => 'structure', 'members' => [ 'Origins' => [ 'shape' => 'OriginsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListBotsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'LexVersion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult25', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'LexVersion' => [ 'shape' => 'LexVersion', 'location' => 'querystring', 'locationName' => 'lexVersion', ], ], ], 'ListBotsResponse' => [ 'type' => 'structure', 'members' => [ 'LexBots' => [ 'shape' => 'LexBotConfigList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListContactEvaluationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'querystring', 'locationName' => 'contactId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListContactEvaluationsResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationSummaryList', ], 'members' => [ 'EvaluationSummaryList' => [ 'shape' => 'EvaluationSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListContactFlowModulesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'ContactFlowModuleState' => [ 'shape' => 'ContactFlowModuleState', 'location' => 'querystring', 'locationName' => 'state', ], ], ], 'ListContactFlowModulesResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowModulesSummaryList' => [ 'shape' => 'ContactFlowModulesSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListContactFlowsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowTypes' => [ 'shape' => 'ContactFlowTypes', 'location' => 'querystring', 'locationName' => 'contactFlowTypes', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListContactFlowsResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowSummaryList' => [ 'shape' => 'ContactFlowSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListContactReferencesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ReferenceTypes', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'ReferenceTypes' => [ 'shape' => 'ReferenceTypes', 'location' => 'querystring', 'locationName' => 'referenceTypes', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListContactReferencesResponse' => [ 'type' => 'structure', 'members' => [ 'ReferenceSummaryList' => [ 'shape' => 'ReferenceSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDefaultVocabulariesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'MaxResults' => [ 'shape' => 'MaxResult100', ], 'NextToken' => [ 'shape' => 'VocabularyNextToken', ], ], ], 'ListDefaultVocabulariesResponse' => [ 'type' => 'structure', 'required' => [ 'DefaultVocabularyList', ], 'members' => [ 'DefaultVocabularyList' => [ 'shape' => 'DefaultVocabularyList', ], 'NextToken' => [ 'shape' => 'VocabularyNextToken', ], ], ], 'ListEvaluationFormVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListEvaluationFormVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormVersionSummaryList', ], 'members' => [ 'EvaluationFormVersionSummaryList' => [ 'shape' => 'EvaluationFormVersionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEvaluationFormsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListEvaluationFormsResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormSummaryList', ], 'members' => [ 'EvaluationFormSummaryList' => [ 'shape' => 'EvaluationFormSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFlowAssociationResourceType' => [ 'type' => 'string', 'enum' => [ 'VOICE_PHONE_NUMBER', ], ], 'ListFlowAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceType' => [ 'shape' => 'ListFlowAssociationResourceType', 'location' => 'querystring', 'locationName' => 'ResourceType', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListFlowAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'FlowAssociationSummaryList' => [ 'shape' => 'FlowAssociationSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHoursOfOperationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListHoursOfOperationsResponse' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperationSummaryList' => [ 'shape' => 'HoursOfOperationSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInstanceAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult7', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListInstanceAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'Attributes' => [ 'shape' => 'AttributesList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInstanceStorageConfigsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult10', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListInstanceStorageConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'StorageConfigs' => [ 'shape' => 'InstanceStorageConfigs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult10', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'InstanceSummaryList' => [ 'shape' => 'InstanceSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListIntegrationAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationType' => [ 'shape' => 'IntegrationType', 'location' => 'querystring', 'locationName' => 'integrationType', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'IntegrationArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'integrationArn', ], ], ], 'ListIntegrationAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'IntegrationAssociationSummaryList' => [ 'shape' => 'IntegrationAssociationSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLambdaFunctionsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult25', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListLambdaFunctionsResponse' => [ 'type' => 'structure', 'members' => [ 'LambdaFunctions' => [ 'shape' => 'FunctionArnsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLexBotsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult25', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListLexBotsResponse' => [ 'type' => 'structure', 'members' => [ 'LexBots' => [ 'shape' => 'LexBotsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPhoneNumbersRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PhoneNumberTypes' => [ 'shape' => 'PhoneNumberTypes', 'location' => 'querystring', 'locationName' => 'phoneNumberTypes', ], 'PhoneNumberCountryCodes' => [ 'shape' => 'PhoneNumberCountryCodes', 'location' => 'querystring', 'locationName' => 'phoneNumberCountryCodes', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListPhoneNumbersResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberSummaryList' => [ 'shape' => 'PhoneNumberSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPhoneNumbersSummary' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'SourcePhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'ListPhoneNumbersSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ListPhoneNumbersSummary', ], ], 'ListPhoneNumbersV2Request' => [ 'type' => 'structure', 'members' => [ 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'PhoneNumberCountryCodes' => [ 'shape' => 'PhoneNumberCountryCodes', ], 'PhoneNumberTypes' => [ 'shape' => 'PhoneNumberTypes', ], 'PhoneNumberPrefix' => [ 'shape' => 'PhoneNumberPrefix', ], ], ], 'ListPhoneNumbersV2Response' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'ListPhoneNumbersSummaryList' => [ 'shape' => 'ListPhoneNumbersSummaryList', ], ], ], 'ListPredefinedAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListPredefinedAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'PredefinedAttributeSummaryList' => [ 'shape' => 'PredefinedAttributeSummaryList', ], ], ], 'ListPromptsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListPromptsResponse' => [ 'type' => 'structure', 'members' => [ 'PromptSummaryList' => [ 'shape' => 'PromptSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListQueueQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListQueueQuickConnectsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'QuickConnectSummaryList' => [ 'shape' => 'QuickConnectSummaryList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueTypes' => [ 'shape' => 'QueueTypes', 'location' => 'querystring', 'locationName' => 'queueTypes', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListQueuesResponse' => [ 'type' => 'structure', 'members' => [ 'QueueSummaryList' => [ 'shape' => 'QueueSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'QuickConnectTypes' => [ 'shape' => 'QuickConnectTypes', 'location' => 'querystring', 'locationName' => 'QuickConnectTypes', ], ], ], 'ListQuickConnectsResponse' => [ 'type' => 'structure', 'members' => [ 'QuickConnectSummaryList' => [ 'shape' => 'QuickConnectSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRealtimeContactAnalysisSegmentsV2Request' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'OutputType', 'SegmentTypes', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'MaxResults' => [ 'shape' => 'MaxResult100', ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'OutputType' => [ 'shape' => 'RealTimeContactAnalysisOutputType', ], 'SegmentTypes' => [ 'shape' => 'RealTimeContactAnalysisSegmentTypes', ], ], ], 'ListRealtimeContactAnalysisSegmentsV2Response' => [ 'type' => 'structure', 'required' => [ 'Channel', 'Status', 'Segments', ], 'members' => [ 'Channel' => [ 'shape' => 'RealTimeContactAnalysisSupportedChannel', ], 'Status' => [ 'shape' => 'RealTimeContactAnalysisStatus', ], 'Segments' => [ 'shape' => 'RealtimeContactAnalysisSegments', ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], ], ], 'ListRoutingProfileQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRoutingProfileQueuesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'RoutingProfileQueueConfigSummaryList' => [ 'shape' => 'RoutingProfileQueueConfigSummaryList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListRoutingProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRoutingProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'RoutingProfileSummaryList' => [ 'shape' => 'RoutingProfileSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRulesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', 'location' => 'querystring', 'locationName' => 'publishStatus', ], 'EventSourceName' => [ 'shape' => 'EventSourceName', 'location' => 'querystring', 'locationName' => 'eventSourceName', ], 'MaxResults' => [ 'shape' => 'MaxResult200', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListRulesResponse' => [ 'type' => 'structure', 'required' => [ 'RuleSummaryList', ], 'members' => [ 'RuleSummaryList' => [ 'shape' => 'RuleSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSecurityKeysRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult2', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSecurityKeysResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityKeys' => [ 'shape' => 'SecurityKeysList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSecurityProfileApplicationsRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileId', 'InstanceId', ], 'members' => [ 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSecurityProfileApplicationsResponse' => [ 'type' => 'structure', 'members' => [ 'Applications' => [ 'shape' => 'Applications', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListSecurityProfilePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileId', 'InstanceId', ], 'members' => [ 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSecurityProfilePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'PermissionsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListSecurityProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSecurityProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityProfileSummaryList' => [ 'shape' => 'SecurityProfileSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ListTaskTemplatesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'Name' => [ 'shape' => 'TaskTemplateName', 'location' => 'querystring', 'locationName' => 'name', ], ], ], 'ListTaskTemplatesResponse' => [ 'type' => 'structure', 'members' => [ 'TaskTemplates' => [ 'shape' => 'TaskTemplateList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrafficDistributionGroupUsersRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], 'MaxResults' => [ 'shape' => 'MaxResult10', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListTrafficDistributionGroupUsersResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'TrafficDistributionGroupUserSummaryList' => [ 'shape' => 'TrafficDistributionGroupUserSummaryList', ], ], ], 'ListTrafficDistributionGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResult10', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'InstanceId' => [ 'shape' => 'InstanceIdOrArn', 'location' => 'querystring', 'locationName' => 'instanceId', ], ], ], 'ListTrafficDistributionGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'TrafficDistributionGroupSummaryList' => [ 'shape' => 'TrafficDistributionGroupSummaryList', ], ], ], 'ListUseCasesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationAssociationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', 'location' => 'uri', 'locationName' => 'IntegrationAssociationId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListUseCasesResponse' => [ 'type' => 'structure', 'members' => [ 'UseCaseSummaryList' => [ 'shape' => 'UseCaseSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserHierarchyGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListUserHierarchyGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'UserHierarchyGroupSummaryList' => [ 'shape' => 'HierarchyGroupSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserProficienciesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListUserProficienciesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'UserProficiencyList' => [ 'shape' => 'UserProficiencyList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListUsersRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListUsersResponse' => [ 'type' => 'structure', 'members' => [ 'UserSummaryList' => [ 'shape' => 'UserSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListViewVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'NextToken' => [ 'shape' => 'ViewsNextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListViewVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ViewVersionSummaryList' => [ 'shape' => 'ViewVersionSummaryList', ], 'NextToken' => [ 'shape' => 'ViewsNextToken', ], ], ], 'ListViewsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Type' => [ 'shape' => 'ViewType', 'location' => 'querystring', 'locationName' => 'type', ], 'NextToken' => [ 'shape' => 'ViewsNextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListViewsResponse' => [ 'type' => 'structure', 'members' => [ 'ViewsSummaryList' => [ 'shape' => 'ViewsSummaryList', ], 'NextToken' => [ 'shape' => 'ViewsNextToken', ], ], ], 'Long' => [ 'type' => 'long', ], 'MaxResult10' => [ 'type' => 'integer', 'max' => 10, 'min' => 1, ], 'MaxResult100' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxResult1000' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'MaxResult2' => [ 'type' => 'integer', 'max' => 2, 'min' => 1, ], 'MaxResult200' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'MaxResult25' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'MaxResult500' => [ 'type' => 'integer', 'box' => true, 'max' => 500, 'min' => 1, ], 'MaxResult7' => [ 'type' => 'integer', 'max' => 7, 'min' => 1, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaximumResultReturnedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'MediaConcurrencies' => [ 'type' => 'list', 'member' => [ 'shape' => 'MediaConcurrency', ], ], 'MediaConcurrency' => [ 'type' => 'structure', 'required' => [ 'Channel', 'Concurrency', ], 'members' => [ 'Channel' => [ 'shape' => 'Channel', ], 'Concurrency' => [ 'shape' => 'Concurrency', ], 'CrossChannelBehavior' => [ 'shape' => 'CrossChannelBehavior', ], ], ], 'MediaPlacement' => [ 'type' => 'structure', 'members' => [ 'AudioHostUrl' => [ 'shape' => 'URI', ], 'AudioFallbackUrl' => [ 'shape' => 'URI', ], 'SignalingUrl' => [ 'shape' => 'URI', ], 'TurnControlUrl' => [ 'shape' => 'URI', ], 'EventIngestionUrl' => [ 'shape' => 'URI', ], ], ], 'MediaRegion' => [ 'type' => 'string', ], 'Meeting' => [ 'type' => 'structure', 'members' => [ 'MediaRegion' => [ 'shape' => 'MediaRegion', ], 'MediaPlacement' => [ 'shape' => 'MediaPlacement', ], 'MeetingFeatures' => [ 'shape' => 'MeetingFeaturesConfiguration', ], 'MeetingId' => [ 'shape' => 'MeetingId', ], ], ], 'MeetingFeatureStatus' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'UNAVAILABLE', ], ], 'MeetingFeaturesConfiguration' => [ 'type' => 'structure', 'members' => [ 'Audio' => [ 'shape' => 'AudioFeatures', ], ], ], 'MeetingId' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'MetadataUrl' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, ], 'MetricDataCollectionsV2' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDataV2', ], ], 'MetricDataV2' => [ 'type' => 'structure', 'members' => [ 'Metric' => [ 'shape' => 'MetricV2', ], 'Value' => [ 'shape' => 'Value', 'box' => true, ], ], ], 'MetricFilterV2' => [ 'type' => 'structure', 'members' => [ 'MetricFilterKey' => [ 'shape' => 'String', ], 'MetricFilterValues' => [ 'shape' => 'MetricFilterValueList', ], 'Negate' => [ 'shape' => 'Boolean', ], ], ], 'MetricFilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 10, 'min' => 1, ], 'MetricFiltersV2List' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricFilterV2', ], 'max' => 2, ], 'MetricInterval' => [ 'type' => 'structure', 'members' => [ 'Interval' => [ 'shape' => 'IntervalPeriod', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'MetricNameV2' => [ 'type' => 'string', ], 'MetricResultV2' => [ 'type' => 'structure', 'members' => [ 'Dimensions' => [ 'shape' => 'DimensionsV2Map', ], 'MetricInterval' => [ 'shape' => 'MetricInterval', ], 'Collections' => [ 'shape' => 'MetricDataCollectionsV2', ], ], ], 'MetricResultsV2' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricResultV2', ], ], 'MetricV2' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'MetricNameV2', ], 'Threshold' => [ 'shape' => 'ThresholdCollections', ], 'MetricFilters' => [ 'shape' => 'MetricFiltersV2List', ], ], ], 'MetricsV2' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricV2', ], ], 'MinutesLimit60' => [ 'type' => 'integer', 'max' => 59, 'min' => 0, ], 'MonitorCapability' => [ 'type' => 'string', 'enum' => [ 'SILENT_MONITOR', 'BARGE', ], ], 'MonitorContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'UserId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'UserId' => [ 'shape' => 'AgentResourceId', ], 'AllowedMonitorCapabilities' => [ 'shape' => 'AllowedMonitorCapabilities', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'MonitorContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'ContactArn' => [ 'shape' => 'ARN', ], ], ], 'Name' => [ 'type' => 'string', 'max' => 512, 'min' => 0, 'sensitive' => true, ], 'Name128' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(^[\\S].*[\\S]$)|(^[\\S]$)', ], 'Namespace' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'NewChatCreated' => [ 'type' => 'boolean', ], 'NewSessionDetails' => [ 'type' => 'structure', 'members' => [ 'SupportedMessagingContentTypes' => [ 'shape' => 'SupportedMessagingContentTypes', ], 'ParticipantDetails' => [ 'shape' => 'ParticipantDetails', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'StreamingConfiguration' => [ 'shape' => 'ChatStreamingConfiguration', ], ], ], 'NextToken' => [ 'type' => 'string', ], 'NextToken2500' => [ 'type' => 'string', 'max' => 2500, 'min' => 1, ], 'NotificationContentType' => [ 'type' => 'string', 'enum' => [ 'PLAIN_TEXT', ], ], 'NotificationDeliveryType' => [ 'type' => 'string', 'enum' => [ 'EMAIL', ], ], 'NotificationRecipientType' => [ 'type' => 'structure', 'members' => [ 'UserTags' => [ 'shape' => 'UserTagMap', ], 'UserIds' => [ 'shape' => 'UserIdList', ], ], ], 'NumberReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'NumericQuestionPropertyAutomationLabel' => [ 'type' => 'string', 'enum' => [ 'OVERALL_CUSTOMER_SENTIMENT_SCORE', 'OVERALL_AGENT_SENTIMENT_SCORE', 'NON_TALK_TIME', 'NON_TALK_TIME_PERCENTAGE', 'NUMBER_OF_INTERRUPTIONS', 'CONTACT_DURATION', 'AGENT_INTERACTION_DURATION', 'CUSTOMER_HOLD_TIME', ], ], 'NumericQuestionPropertyValueAutomation' => [ 'type' => 'structure', 'required' => [ 'Label', ], 'members' => [ 'Label' => [ 'shape' => 'NumericQuestionPropertyAutomationLabel', ], ], ], 'OperatingSystem' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'Origin' => [ 'type' => 'string', 'max' => 267, ], 'OriginsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Origin', ], ], 'OutboundCallerConfig' => [ 'type' => 'structure', 'members' => [ 'OutboundCallerIdName' => [ 'shape' => 'OutboundCallerIdName', ], 'OutboundCallerIdNumberId' => [ 'shape' => 'PhoneNumberId', ], 'OutboundFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'OutboundCallerIdName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'OutboundCallsEnabled' => [ 'type' => 'boolean', ], 'OutboundContactNotPermittedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'OutputTypeNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'PEM' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ParticipantCapabilities' => [ 'type' => 'structure', 'members' => [ 'Video' => [ 'shape' => 'VideoCapability', ], ], ], 'ParticipantDetails' => [ 'type' => 'structure', 'required' => [ 'DisplayName', ], 'members' => [ 'DisplayName' => [ 'shape' => 'DisplayName', ], ], ], 'ParticipantDetailsToAdd' => [ 'type' => 'structure', 'members' => [ 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], ], ], 'ParticipantId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ParticipantRole' => [ 'type' => 'string', 'enum' => [ 'AGENT', 'CUSTOMER', 'SYSTEM', 'CUSTOM_BOT', 'SUPERVISOR', ], ], 'ParticipantTimerAction' => [ 'type' => 'string', 'enum' => [ 'Unset', ], ], 'ParticipantTimerConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParticipantTimerConfiguration', ], 'max' => 6, 'min' => 1, ], 'ParticipantTimerConfiguration' => [ 'type' => 'structure', 'required' => [ 'ParticipantRole', 'TimerType', 'TimerValue', ], 'members' => [ 'ParticipantRole' => [ 'shape' => 'TimerEligibleParticipantRoles', ], 'TimerType' => [ 'shape' => 'ParticipantTimerType', ], 'TimerValue' => [ 'shape' => 'ParticipantTimerValue', ], ], ], 'ParticipantTimerDurationInMinutes' => [ 'type' => 'integer', 'max' => 480, 'min' => 2, ], 'ParticipantTimerType' => [ 'type' => 'string', 'enum' => [ 'IDLE', 'DISCONNECT_NONCUSTOMER', ], ], 'ParticipantTimerValue' => [ 'type' => 'structure', 'members' => [ 'ParticipantTimerAction' => [ 'shape' => 'ParticipantTimerAction', ], 'ParticipantTimerDurationInMinutes' => [ 'shape' => 'ParticipantTimerDurationInMinutes', ], ], 'union' => true, ], 'ParticipantToken' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'ParticipantTokenCredentials' => [ 'type' => 'structure', 'members' => [ 'ParticipantToken' => [ 'shape' => 'ParticipantToken', ], 'Expiry' => [ 'shape' => 'ISO8601Datetime', ], ], ], 'Password' => [ 'type' => 'string', 'pattern' => '/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/', 'sensitive' => true, ], 'PauseContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'PauseContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'Permission' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'PermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfilePermission', ], 'max' => 500, ], 'PersistentChat' => [ 'type' => 'structure', 'members' => [ 'RehydrationType' => [ 'shape' => 'RehydrationType', ], 'SourceContactId' => [ 'shape' => 'ContactId', ], ], ], 'PhoneNumber' => [ 'type' => 'string', 'pattern' => '\\\\+[1-9]\\\\d{1,14}$', ], 'PhoneNumberCountryCode' => [ 'type' => 'string', 'enum' => [ 'AF', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BA', 'BW', 'BR', 'IO', 'VG', 'BN', 'BG', 'BF', 'BI', 'KH', 'CM', 'CA', 'CV', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CK', 'CR', 'HR', 'CU', 'CW', 'CY', 'CZ', 'CD', 'DK', 'DJ', 'DM', 'DO', 'TL', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'PF', 'GA', 'GM', 'GE', 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT', 'CI', 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KW', 'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MR', 'MU', 'YT', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP', 'NL', 'AN', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'KP', 'MP', 'NO', 'OM', 'PK', 'PW', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR', 'QA', 'CG', 'RE', 'RO', 'RU', 'RW', 'BL', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS', 'SM', 'ST', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB', 'SO', 'ZA', 'KR', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'VI', 'UG', 'UA', 'AE', 'GB', 'US', 'UY', 'UZ', 'VU', 'VA', 'VE', 'VN', 'WF', 'EH', 'YE', 'ZM', 'ZW', ], ], 'PhoneNumberCountryCodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberCountryCode', ], 'max' => 10, ], 'PhoneNumberDescription' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^[\\W\\S_]*', ], 'PhoneNumberId' => [ 'type' => 'string', ], 'PhoneNumberPrefix' => [ 'type' => 'string', 'pattern' => '\\\\+?[0-9]{1,11}', ], 'PhoneNumberQuickConnectConfig' => [ 'type' => 'structure', 'required' => [ 'PhoneNumber', ], 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'PhoneNumberStatus' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'PhoneNumberWorkflowStatus', ], 'Message' => [ 'shape' => 'PhoneNumberWorkflowMessage', ], ], ], 'PhoneNumberSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'PhoneNumberId', ], 'Arn' => [ 'shape' => 'ARN', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], ], ], 'PhoneNumberSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberSummary', ], ], 'PhoneNumberType' => [ 'type' => 'string', 'enum' => [ 'TOLL_FREE', 'DID', 'UIFN', 'SHARED', 'THIRD_PARTY_TF', 'THIRD_PARTY_DID', 'SHORT_CODE', ], ], 'PhoneNumberTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberType', ], 'max' => 6, ], 'PhoneNumberWorkflowMessage' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '^[\\W\\S_]*', ], 'PhoneNumberWorkflowStatus' => [ 'type' => 'string', 'enum' => [ 'CLAIMED', 'IN_PROGRESS', 'FAILED', ], ], 'PhoneType' => [ 'type' => 'string', 'enum' => [ 'SOFT_PHONE', 'DESK_PHONE', ], ], 'PlatformName' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'PlatformVersion' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'PotentialAudioQualityIssue' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'PotentialAudioQualityIssues' => [ 'type' => 'list', 'member' => [ 'shape' => 'PotentialAudioQualityIssue', ], 'max' => 3, 'min' => 0, ], 'PotentialDisconnectIssue' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'PredefinedAttribute' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'PredefinedAttributeName', ], 'Values' => [ 'shape' => 'PredefinedAttributeValues', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'PredefinedAttributeName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'PredefinedAttributeSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PredefinedAttributeSearchCriteria', ], ], 'PredefinedAttributeSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'PredefinedAttributeSearchConditionList', ], 'AndConditions' => [ 'shape' => 'PredefinedAttributeSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'PredefinedAttributeSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PredefinedAttribute', ], ], 'PredefinedAttributeStringValue' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'PredefinedAttributeStringValuesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PredefinedAttributeStringValue', ], 'max' => 128, 'min' => 1, ], 'PredefinedAttributeSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'PredefinedAttributeName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'PredefinedAttributeSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PredefinedAttributeSummary', ], ], 'PredefinedAttributeValues' => [ 'type' => 'structure', 'members' => [ 'StringList' => [ 'shape' => 'PredefinedAttributeStringValuesList', ], ], 'union' => true, ], 'Prefix' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'Priority' => [ 'type' => 'integer', 'max' => 99, 'min' => 1, ], 'ProblemDetail' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ProblemMessageString', ], ], ], 'ProblemMessageString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Problems' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProblemDetail', ], 'max' => 50, 'min' => 1, ], 'ProficiencyLevel' => [ 'type' => 'float', 'box' => true, 'max' => 5.0, 'min' => 1.0, ], 'ProficiencyValue' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'Prompt' => [ 'type' => 'structure', 'members' => [ 'PromptARN' => [ 'shape' => 'ARN', ], 'PromptId' => [ 'shape' => 'PromptId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'PromptDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'PromptDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'PromptId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'PromptList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Prompt', ], ], 'PromptName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'PromptPresignedUrl' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, ], 'PromptSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PromptSearchCriteria', ], ], 'PromptSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'PromptSearchConditionList', ], 'AndConditions' => [ 'shape' => 'PromptSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'PromptSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'PromptSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'PromptId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'PromptName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'PromptSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PromptSummary', ], ], 'PropertyValidationException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'Message', ], 'PropertyList' => [ 'shape' => 'PropertyValidationExceptionPropertyList', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'PropertyValidationExceptionProperty' => [ 'type' => 'structure', 'required' => [ 'PropertyPath', 'Reason', 'Message', ], 'members' => [ 'PropertyPath' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'PropertyValidationExceptionReason', ], 'Message' => [ 'shape' => 'Message', ], ], ], 'PropertyValidationExceptionPropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyValidationExceptionProperty', ], ], 'PropertyValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'INVALID_FORMAT', 'UNIQUE_CONSTRAINT_VIOLATED', 'REFERENCED_RESOURCE_NOT_FOUND', 'RESOURCE_NAME_ALREADY_EXISTS', 'REQUIRED_PROPERTY_MISSING', 'NOT_SUPPORTED', ], ], 'PutUserStatusRequest' => [ 'type' => 'structure', 'required' => [ 'UserId', 'InstanceId', 'AgentStatusId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', ], ], ], 'PutUserStatusResponse' => [ 'type' => 'structure', 'members' => [], ], 'QualityMetrics' => [ 'type' => 'structure', 'members' => [ 'Agent' => [ 'shape' => 'AgentQualityMetrics', ], 'Customer' => [ 'shape' => 'CustomerQualityMetrics', ], ], ], 'Queue' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'CommonNameLength127', ], 'QueueArn' => [ 'shape' => 'ARN', ], 'QueueId' => [ 'shape' => 'QueueId', ], 'Description' => [ 'shape' => 'QueueDescription', ], 'OutboundCallerConfig' => [ 'shape' => 'OutboundCallerConfig', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], 'MaxContacts' => [ 'shape' => 'QueueMaxContacts', 'box' => true, ], 'Status' => [ 'shape' => 'QueueStatus', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'QueueDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'QueueId' => [ 'type' => 'string', ], 'QueueIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueId', ], 'max' => 100, 'min' => 0, ], 'QueueInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QueueId', ], 'EnqueueTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'QueueMaxContacts' => [ 'type' => 'integer', 'min' => 0, ], 'QueueName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'QueuePriority' => [ 'type' => 'long', 'max' => 9223372036854775807, 'min' => 1, ], 'QueueQuickConnectConfig' => [ 'type' => 'structure', 'required' => [ 'QueueId', 'ContactFlowId', ], 'members' => [ 'QueueId' => [ 'shape' => 'QueueId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'QueueReference' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QueueId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'QueueSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueSearchCriteria', ], ], 'QueueSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'QueueSearchConditionList', ], 'AndConditions' => [ 'shape' => 'QueueSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], 'QueueTypeCondition' => [ 'shape' => 'SearchableQueueType', ], ], ], 'QueueSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'QueueSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Queue', ], ], 'QueueStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'QueueSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QueueId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'QueueName', ], 'QueueType' => [ 'shape' => 'QueueType', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'QueueSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueSummary', ], ], 'QueueTimeAdjustmentSeconds' => [ 'type' => 'integer', ], 'QueueType' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'AGENT', ], ], 'QueueTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueType', ], 'max' => 2, ], 'Queues' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueId', ], 'max' => 100, 'min' => 1, ], 'QuickConnect' => [ 'type' => 'structure', 'members' => [ 'QuickConnectARN' => [ 'shape' => 'ARN', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', ], 'Name' => [ 'shape' => 'QuickConnectName', ], 'Description' => [ 'shape' => 'QuickConnectDescription', ], 'QuickConnectConfig' => [ 'shape' => 'QuickConnectConfig', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'QuickConnectConfig' => [ 'type' => 'structure', 'required' => [ 'QuickConnectType', ], 'members' => [ 'QuickConnectType' => [ 'shape' => 'QuickConnectType', ], 'UserConfig' => [ 'shape' => 'UserQuickConnectConfig', ], 'QueueConfig' => [ 'shape' => 'QueueQuickConnectConfig', ], 'PhoneConfig' => [ 'shape' => 'PhoneNumberQuickConnectConfig', ], ], ], 'QuickConnectDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'QuickConnectId' => [ 'type' => 'string', ], 'QuickConnectName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'QuickConnectSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnectSearchCriteria', ], ], 'QuickConnectSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'QuickConnectSearchConditionList', ], 'AndConditions' => [ 'shape' => 'QuickConnectSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'QuickConnectSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'QuickConnectSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnect', ], ], 'QuickConnectSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QuickConnectId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'QuickConnectName', ], 'QuickConnectType' => [ 'shape' => 'QuickConnectType', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'QuickConnectSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnectSummary', ], ], 'QuickConnectType' => [ 'type' => 'string', 'enum' => [ 'USER', 'QUEUE', 'PHONE_NUMBER', ], ], 'QuickConnectTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnectType', ], 'max' => 3, ], 'QuickConnectsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnectId', ], 'max' => 50, 'min' => 1, ], 'ReadOnlyFieldInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], ], ], 'ReadOnlyTaskTemplateFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadOnlyFieldInfo', ], ], 'RealTimeContactAnalysisAttachment' => [ 'type' => 'structure', 'required' => [ 'AttachmentName', 'AttachmentId', ], 'members' => [ 'AttachmentName' => [ 'shape' => 'AttachmentName', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'AttachmentId' => [ 'shape' => 'ArtifactId', ], 'Status' => [ 'shape' => 'ArtifactStatus', ], ], ], 'RealTimeContactAnalysisAttachments' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisAttachment', ], 'max' => 10, ], 'RealTimeContactAnalysisCategoryDetails' => [ 'type' => 'structure', 'required' => [ 'PointsOfInterest', ], 'members' => [ 'PointsOfInterest' => [ 'shape' => 'RealTimeContactAnalysisPointsOfInterest', ], ], ], 'RealTimeContactAnalysisCategoryName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RealTimeContactAnalysisCharacterInterval' => [ 'type' => 'structure', 'required' => [ 'BeginOffsetChar', 'EndOffsetChar', ], 'members' => [ 'BeginOffsetChar' => [ 'shape' => 'RealTimeContactAnalysisOffset', ], 'EndOffsetChar' => [ 'shape' => 'RealTimeContactAnalysisOffset', ], ], ], 'RealTimeContactAnalysisCharacterIntervals' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisCharacterInterval', ], ], 'RealTimeContactAnalysisContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RealTimeContactAnalysisEventType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'RealTimeContactAnalysisId256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RealTimeContactAnalysisIssueDetected' => [ 'type' => 'structure', 'required' => [ 'TranscriptItems', ], 'members' => [ 'TranscriptItems' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemsWithContent', ], ], ], 'RealTimeContactAnalysisIssuesDetected' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisIssueDetected', ], ], 'RealTimeContactAnalysisMatchedDetails' => [ 'type' => 'map', 'key' => [ 'shape' => 'RealTimeContactAnalysisCategoryName', ], 'value' => [ 'shape' => 'RealTimeContactAnalysisCategoryDetails', ], 'max' => 150, 'min' => 0, ], 'RealTimeContactAnalysisOffset' => [ 'type' => 'integer', 'min' => 0, ], 'RealTimeContactAnalysisOutputType' => [ 'type' => 'string', 'enum' => [ 'Raw', 'Redacted', ], ], 'RealTimeContactAnalysisPointOfInterest' => [ 'type' => 'structure', 'members' => [ 'TranscriptItems' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets', ], ], ], 'RealTimeContactAnalysisPointsOfInterest' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisPointOfInterest', ], 'max' => 5, 'min' => 0, ], 'RealTimeContactAnalysisSegmentAttachments' => [ 'type' => 'structure', 'required' => [ 'Id', 'ParticipantId', 'ParticipantRole', 'Attachments', 'Time', ], 'members' => [ 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], 'Attachments' => [ 'shape' => 'RealTimeContactAnalysisAttachments', ], 'Time' => [ 'shape' => 'RealTimeContactAnalysisTimeData', ], ], ], 'RealTimeContactAnalysisSegmentCategories' => [ 'type' => 'structure', 'required' => [ 'MatchedDetails', ], 'members' => [ 'MatchedDetails' => [ 'shape' => 'RealTimeContactAnalysisMatchedDetails', ], ], ], 'RealTimeContactAnalysisSegmentEvent' => [ 'type' => 'structure', 'required' => [ 'Id', 'EventType', 'Time', ], 'members' => [ 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], 'EventType' => [ 'shape' => 'RealTimeContactAnalysisEventType', ], 'Time' => [ 'shape' => 'RealTimeContactAnalysisTimeData', ], ], ], 'RealTimeContactAnalysisSegmentIssues' => [ 'type' => 'structure', 'required' => [ 'IssuesDetected', ], 'members' => [ 'IssuesDetected' => [ 'shape' => 'RealTimeContactAnalysisIssuesDetected', ], ], ], 'RealTimeContactAnalysisSegmentTranscript' => [ 'type' => 'structure', 'required' => [ 'Id', 'ParticipantId', 'ParticipantRole', 'Content', 'Time', ], 'members' => [ 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], 'Content' => [ 'shape' => 'RealTimeContactAnalysisTranscriptContent', ], 'ContentType' => [ 'shape' => 'RealTimeContactAnalysisContentType', ], 'Time' => [ 'shape' => 'RealTimeContactAnalysisTimeData', ], 'Redaction' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemRedaction', ], 'Sentiment' => [ 'shape' => 'RealTimeContactAnalysisSentimentLabel', ], ], ], 'RealTimeContactAnalysisSegmentType' => [ 'type' => 'string', 'enum' => [ 'Transcript', 'Categories', 'Issues', 'Event', 'Attachments', ], ], 'RealTimeContactAnalysisSegmentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisSegmentType', ], 'max' => 5, ], 'RealTimeContactAnalysisSentimentLabel' => [ 'type' => 'string', 'enum' => [ 'POSITIVE', 'NEGATIVE', 'NEUTRAL', ], ], 'RealTimeContactAnalysisStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'FAILED', 'COMPLETED', ], ], 'RealTimeContactAnalysisSupportedChannel' => [ 'type' => 'string', 'enum' => [ 'VOICE', 'CHAT', ], ], 'RealTimeContactAnalysisTimeData' => [ 'type' => 'structure', 'members' => [ 'AbsoluteTime' => [ 'shape' => 'RealTimeContactAnalysisTimeInstant', ], ], 'union' => true, ], 'RealTimeContactAnalysisTimeInstant' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'RealTimeContactAnalysisTranscriptContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, ], 'RealTimeContactAnalysisTranscriptItemRedaction' => [ 'type' => 'structure', 'members' => [ 'CharacterOffsets' => [ 'shape' => 'RealTimeContactAnalysisCharacterIntervals', ], ], ], 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'CharacterOffsets' => [ 'shape' => 'RealTimeContactAnalysisCharacterInterval', ], ], ], 'RealTimeContactAnalysisTranscriptItemWithContent' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Content' => [ 'shape' => 'RealTimeContactAnalysisTranscriptContent', ], 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'CharacterOffsets' => [ 'shape' => 'RealTimeContactAnalysisCharacterInterval', ], ], ], 'RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets', ], 'max' => 10, 'min' => 0, ], 'RealTimeContactAnalysisTranscriptItemsWithContent' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemWithContent', ], ], 'RealtimeContactAnalysisSegment' => [ 'type' => 'structure', 'members' => [ 'Transcript' => [ 'shape' => 'RealTimeContactAnalysisSegmentTranscript', ], 'Categories' => [ 'shape' => 'RealTimeContactAnalysisSegmentCategories', ], 'Issues' => [ 'shape' => 'RealTimeContactAnalysisSegmentIssues', ], 'Event' => [ 'shape' => 'RealTimeContactAnalysisSegmentEvent', ], 'Attachments' => [ 'shape' => 'RealTimeContactAnalysisSegmentAttachments', ], ], 'union' => true, ], 'RealtimeContactAnalysisSegments' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealtimeContactAnalysisSegment', ], ], 'Reference' => [ 'type' => 'structure', 'required' => [ 'Value', 'Type', ], 'members' => [ 'Value' => [ 'shape' => 'ReferenceValue', ], 'Type' => [ 'shape' => 'ReferenceType', ], ], ], 'ReferenceId' => [ 'type' => 'string', 'max' => 40, 'min' => 1, ], 'ReferenceKey' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'ReferenceStatus' => [ 'type' => 'string', 'enum' => [ 'APPROVED', 'REJECTED', ], ], 'ReferenceSummary' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'UrlReference', ], 'Attachment' => [ 'shape' => 'AttachmentReference', ], 'String' => [ 'shape' => 'StringReference', ], 'Number' => [ 'shape' => 'NumberReference', ], 'Date' => [ 'shape' => 'DateReference', ], 'Email' => [ 'shape' => 'EmailReference', ], ], 'union' => true, ], 'ReferenceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceSummary', ], ], 'ReferenceType' => [ 'type' => 'string', 'enum' => [ 'URL', 'ATTACHMENT', 'NUMBER', 'STRING', 'DATE', 'EMAIL', ], ], 'ReferenceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceType', ], 'max' => 6, ], 'ReferenceValue' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, ], 'RegionName' => [ 'type' => 'string', 'pattern' => '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?', ], 'RehydrationType' => [ 'type' => 'string', 'enum' => [ 'ENTIRE_PAST_SESSION', 'FROM_SEGMENT', ], ], 'ReleasePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, 'location' => 'querystring', 'locationName' => 'clientToken', ], ], ], 'ReplicateInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ReplicaRegion', 'ReplicaAlias', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceIdOrArn', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ReplicaRegion' => [ 'shape' => 'AwsRegion', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ReplicaAlias' => [ 'shape' => 'DirectoryAlias', ], ], ], 'ReplicateInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'RequestIdentifier' => [ 'type' => 'string', 'max' => 80, ], 'RequiredFieldInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], ], ], 'RequiredTaskTemplateFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'RequiredFieldInfo', ], ], 'ResourceArnOrId' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'ResourceConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceId' => [ 'shape' => 'ARN', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResourceNotReadyException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceTagsSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'TagSearchCondition' => [ 'shape' => 'TagSearchCondition', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'CONTACT', 'CONTACT_FLOW', 'INSTANCE', 'PARTICIPANT', 'HIERARCHY_LEVEL', 'HIERARCHY_GROUP', 'USER', 'PHONE_NUMBER', ], ], 'ResourceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ResumeContactRecordingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'InitialContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], ], ], 'ResumeContactRecordingResponse' => [ 'type' => 'structure', 'members' => [], ], 'ResumeContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'ResumeContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'RoutingCriteria' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'Steps', ], 'ActivationTimestamp' => [ 'shape' => 'timestamp', ], 'Index' => [ 'shape' => 'Index', ], ], ], 'RoutingCriteriaStepStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'JOINED', 'EXPIRED', ], ], 'RoutingExpression' => [ 'type' => 'string', 'max' => 3000, 'min' => 1, ], 'RoutingExpressions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingExpression', ], 'max' => 50, ], 'RoutingProfile' => [ 'type' => 'structure', 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Name' => [ 'shape' => 'RoutingProfileName', ], 'RoutingProfileArn' => [ 'shape' => 'ARN', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'Description' => [ 'shape' => 'RoutingProfileDescription', ], 'MediaConcurrencies' => [ 'shape' => 'MediaConcurrencies', ], 'DefaultOutboundQueueId' => [ 'shape' => 'QueueId', ], 'Tags' => [ 'shape' => 'TagMap', ], 'NumberOfAssociatedQueues' => [ 'shape' => 'Long', ], 'NumberOfAssociatedUsers' => [ 'shape' => 'Long', ], 'AgentAvailabilityTimer' => [ 'shape' => 'AgentAvailabilityTimer', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], 'IsDefault' => [ 'shape' => 'Boolean', ], 'AssociatedQueueIds' => [ 'shape' => 'AssociatedQueueIdList', ], ], ], 'RoutingProfileDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'RoutingProfileId' => [ 'type' => 'string', ], 'RoutingProfileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfile', ], ], 'RoutingProfileName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'RoutingProfileQueueConfig' => [ 'type' => 'structure', 'required' => [ 'QueueReference', 'Priority', 'Delay', ], 'members' => [ 'QueueReference' => [ 'shape' => 'RoutingProfileQueueReference', ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'Delay' => [ 'shape' => 'Delay', 'box' => true, ], ], ], 'RoutingProfileQueueConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileQueueConfig', ], 'max' => 10, 'min' => 1, ], 'RoutingProfileQueueConfigSummary' => [ 'type' => 'structure', 'required' => [ 'QueueId', 'QueueArn', 'QueueName', 'Priority', 'Delay', 'Channel', ], 'members' => [ 'QueueId' => [ 'shape' => 'QueueId', ], 'QueueArn' => [ 'shape' => 'ARN', ], 'QueueName' => [ 'shape' => 'QueueName', ], 'Priority' => [ 'shape' => 'Priority', ], 'Delay' => [ 'shape' => 'Delay', ], 'Channel' => [ 'shape' => 'Channel', ], ], ], 'RoutingProfileQueueConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileQueueConfigSummary', ], ], 'RoutingProfileQueueReference' => [ 'type' => 'structure', 'required' => [ 'QueueId', 'Channel', ], 'members' => [ 'QueueId' => [ 'shape' => 'QueueId', ], 'Channel' => [ 'shape' => 'Channel', ], ], ], 'RoutingProfileQueueReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileQueueReference', ], ], 'RoutingProfileReference' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'RoutingProfileId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'RoutingProfileSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileSearchCriteria', ], ], 'RoutingProfileSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'RoutingProfileSearchConditionList', ], 'AndConditions' => [ 'shape' => 'RoutingProfileSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'RoutingProfileSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'RoutingProfileSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'RoutingProfileId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'RoutingProfileName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'RoutingProfileSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileSummary', ], ], 'RoutingProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileId', ], 'max' => 100, 'min' => 1, ], 'Rule' => [ 'type' => 'structure', 'required' => [ 'Name', 'RuleId', 'RuleArn', 'TriggerEventSource', 'Function', 'Actions', 'PublishStatus', 'CreatedTime', 'LastUpdatedTime', 'LastUpdatedBy', ], 'members' => [ 'Name' => [ 'shape' => 'RuleName', ], 'RuleId' => [ 'shape' => 'RuleId', ], 'RuleArn' => [ 'shape' => 'ARN', ], 'TriggerEventSource' => [ 'shape' => 'RuleTriggerEventSource', ], 'Function' => [ 'shape' => 'RuleFunction', ], 'Actions' => [ 'shape' => 'RuleActions', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedBy' => [ 'shape' => 'ARN', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'RuleAction' => [ 'type' => 'structure', 'required' => [ 'ActionType', ], 'members' => [ 'ActionType' => [ 'shape' => 'ActionType', ], 'TaskAction' => [ 'shape' => 'TaskActionDefinition', ], 'EventBridgeAction' => [ 'shape' => 'EventBridgeActionDefinition', ], 'AssignContactCategoryAction' => [ 'shape' => 'AssignContactCategoryActionDefinition', ], 'SendNotificationAction' => [ 'shape' => 'SendNotificationActionDefinition', ], 'CreateCaseAction' => [ 'shape' => 'CreateCaseActionDefinition', ], 'UpdateCaseAction' => [ 'shape' => 'UpdateCaseActionDefinition', ], 'EndAssociatedTasksAction' => [ 'shape' => 'EndAssociatedTasksActionDefinition', ], 'SubmitAutoEvaluationAction' => [ 'shape' => 'SubmitAutoEvaluationActionDefinition', ], ], ], 'RuleActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleAction', ], ], 'RuleFunction' => [ 'type' => 'string', ], 'RuleId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RuleName' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '^[0-9a-zA-Z._-]+', ], 'RulePublishStatus' => [ 'type' => 'string', 'enum' => [ 'DRAFT', 'PUBLISHED', ], ], 'RuleSummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'RuleId', 'RuleArn', 'EventSourceName', 'PublishStatus', 'ActionSummaries', 'CreatedTime', 'LastUpdatedTime', ], 'members' => [ 'Name' => [ 'shape' => 'RuleName', ], 'RuleId' => [ 'shape' => 'RuleId', ], 'RuleArn' => [ 'shape' => 'ARN', ], 'EventSourceName' => [ 'shape' => 'EventSourceName', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', ], 'ActionSummaries' => [ 'shape' => 'ActionSummaries', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'RuleSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleSummary', ], ], 'RuleTriggerEventSource' => [ 'type' => 'structure', 'required' => [ 'EventSourceName', ], 'members' => [ 'EventSourceName' => [ 'shape' => 'EventSourceName', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', ], ], ], 'S3Config' => [ 'type' => 'structure', 'required' => [ 'BucketName', 'BucketPrefix', ], 'members' => [ 'BucketName' => [ 'shape' => 'BucketName', ], 'BucketPrefix' => [ 'shape' => 'Prefix', ], 'EncryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, 'pattern' => 's3://\\S+/.+|https://\\\\S+\\\\.s3\\\\.\\\\S+\\\\.amazonaws\\\\.com/\\\\S+', ], 'SearchAvailablePhoneNumbersRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberCountryCode', 'PhoneNumberType', ], 'members' => [ 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], 'PhoneNumberPrefix' => [ 'shape' => 'PhoneNumberPrefix', ], 'MaxResults' => [ 'shape' => 'MaxResult10', 'box' => true, ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], ], ], 'SearchAvailablePhoneNumbersResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'AvailableNumbersList' => [ 'shape' => 'AvailableNumbersList', ], ], ], 'SearchContactFlowModulesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'ContactFlowModuleSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'ContactFlowModuleSearchCriteria', ], ], ], 'SearchContactFlowModulesResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowModules' => [ 'shape' => 'ContactFlowModuleSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchContactFlowsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'ContactFlowSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'ContactFlowSearchCriteria', ], ], ], 'SearchContactFlowsResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlows' => [ 'shape' => 'ContactFlowSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchContactsMatchType' => [ 'type' => 'string', 'enum' => [ 'MATCH_ALL', 'MATCH_ANY', ], ], 'SearchContactsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'TimeRange', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'TimeRange' => [ 'shape' => 'SearchContactsTimeRange', ], 'SearchCriteria' => [ 'shape' => 'SearchCriteria', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'Sort' => [ 'shape' => 'Sort', ], ], ], 'SearchContactsResponse' => [ 'type' => 'structure', 'required' => [ 'Contacts', ], 'members' => [ 'Contacts' => [ 'shape' => 'Contacts', ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'TotalCount' => [ 'shape' => 'TotalCount', ], ], ], 'SearchContactsTimeRange' => [ 'type' => 'structure', 'required' => [ 'Type', 'StartTime', 'EndTime', ], 'members' => [ 'Type' => [ 'shape' => 'SearchContactsTimeRangeType', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'SearchContactsTimeRangeType' => [ 'type' => 'string', 'enum' => [ 'INITIATION_TIMESTAMP', 'SCHEDULED_TIMESTAMP', 'CONNECTED_TO_AGENT_TIMESTAMP', 'DISCONNECT_TIMESTAMP', ], ], 'SearchCriteria' => [ 'type' => 'structure', 'members' => [ 'AgentIds' => [ 'shape' => 'AgentResourceIdList', ], 'AgentHierarchyGroups' => [ 'shape' => 'AgentHierarchyGroups', ], 'Channels' => [ 'shape' => 'ChannelList', ], 'ContactAnalysis' => [ 'shape' => 'ContactAnalysis', ], 'InitiationMethods' => [ 'shape' => 'InitiationMethodList', ], 'QueueIds' => [ 'shape' => 'QueueIdList', ], 'SearchableContactAttributes' => [ 'shape' => 'SearchableContactAttributes', ], ], ], 'SearchHoursOfOperationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'HoursOfOperationSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'HoursOfOperationSearchCriteria', ], ], ], 'SearchHoursOfOperationsResponse' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperations' => [ 'shape' => 'HoursOfOperationList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchPredefinedAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchCriteria' => [ 'shape' => 'PredefinedAttributeSearchCriteria', ], ], ], 'SearchPredefinedAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'PredefinedAttributes' => [ 'shape' => 'PredefinedAttributeSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchPromptsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'PromptSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'PromptSearchCriteria', ], ], ], 'SearchPromptsResponse' => [ 'type' => 'structure', 'members' => [ 'Prompts' => [ 'shape' => 'PromptList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult500', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'QueueSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'QueueSearchCriteria', ], ], ], 'SearchQueuesResponse' => [ 'type' => 'structure', 'members' => [ 'Queues' => [ 'shape' => 'QueueSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'QuickConnectSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'QuickConnectSearchCriteria', ], ], ], 'SearchQuickConnectsResponse' => [ 'type' => 'structure', 'members' => [ 'QuickConnects' => [ 'shape' => 'QuickConnectSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchResourceTagsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceIdOrArn', ], 'ResourceTypes' => [ 'shape' => 'ResourceTypeList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchCriteria' => [ 'shape' => 'ResourceTagsSearchCriteria', ], ], ], 'SearchResourceTagsResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagsList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], ], ], 'SearchRoutingProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult500', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'RoutingProfileSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'RoutingProfileSearchCriteria', ], ], ], 'SearchRoutingProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'RoutingProfiles' => [ 'shape' => 'RoutingProfileList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchSecurityProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchCriteria' => [ 'shape' => 'SecurityProfileSearchCriteria', ], 'SearchFilter' => [ 'shape' => 'SecurityProfilesSearchFilter', ], ], ], 'SearchSecurityProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityProfiles' => [ 'shape' => 'SecurityProfilesSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchText' => [ 'type' => 'string', 'max' => 128, 'sensitive' => true, ], 'SearchTextList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchText', ], 'max' => 100, 'min' => 0, ], 'SearchUsersRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult500', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'UserSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'UserSearchCriteria', ], ], ], 'SearchUsersResponse' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'UserSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchVocabulariesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'MaxResults' => [ 'shape' => 'MaxResult100', ], 'NextToken' => [ 'shape' => 'VocabularyNextToken', ], 'State' => [ 'shape' => 'VocabularyState', ], 'NameStartsWith' => [ 'shape' => 'VocabularyName', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], ], ], 'SearchVocabulariesResponse' => [ 'type' => 'structure', 'members' => [ 'VocabularySummaryList' => [ 'shape' => 'VocabularySummaryList', ], 'NextToken' => [ 'shape' => 'VocabularyNextToken', ], ], ], 'SearchableContactAttributeKey' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'sensitive' => true, ], 'SearchableContactAttributeValue' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'sensitive' => true, ], 'SearchableContactAttributeValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchableContactAttributeValue', ], 'max' => 20, 'min' => 0, ], 'SearchableContactAttributes' => [ 'type' => 'structure', 'required' => [ 'Criteria', ], 'members' => [ 'Criteria' => [ 'shape' => 'SearchableContactAttributesCriteriaList', ], 'MatchType' => [ 'shape' => 'SearchContactsMatchType', ], ], ], 'SearchableContactAttributesCriteria' => [ 'type' => 'structure', 'required' => [ 'Key', 'Values', ], 'members' => [ 'Key' => [ 'shape' => 'SearchableContactAttributeKey', ], 'Values' => [ 'shape' => 'SearchableContactAttributeValueList', ], ], ], 'SearchableContactAttributesCriteriaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchableContactAttributesCriteria', ], 'max' => 15, 'min' => 0, ], 'SearchableQueueType' => [ 'type' => 'string', 'enum' => [ 'STANDARD', ], ], 'SecurityKey' => [ 'type' => 'structure', 'members' => [ 'AssociationId' => [ 'shape' => 'AssociationId', ], 'Key' => [ 'shape' => 'PEM', ], 'CreationTime' => [ 'shape' => 'timestamp', ], ], ], 'SecurityKeysList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityKey', ], ], 'SecurityProfile' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'SecurityProfileId', ], 'OrganizationResourceId' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], 'SecurityProfileName' => [ 'shape' => 'SecurityProfileName', ], 'Description' => [ 'shape' => 'SecurityProfileDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], 'AllowedAccessControlTags' => [ 'shape' => 'AllowedAccessControlTags', ], 'TagRestrictedResources' => [ 'shape' => 'TagRestrictedResourceList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], 'HierarchyRestrictedResources' => [ 'shape' => 'HierarchyRestrictedResourceList', ], 'AllowedAccessControlHierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], ], ], 'SecurityProfileDescription' => [ 'type' => 'string', 'max' => 250, ], 'SecurityProfileId' => [ 'type' => 'string', ], 'SecurityProfileIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfileId', ], 'max' => 10, 'min' => 1, ], 'SecurityProfileName' => [ 'type' => 'string', ], 'SecurityProfilePermission' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'SecurityProfilePolicyKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'SecurityProfilePolicyValue' => [ 'type' => 'string', 'max' => 256, ], 'SecurityProfileSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfileSearchCriteria', ], ], 'SecurityProfileSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'SecurityProfileSearchConditionList', ], 'AndConditions' => [ 'shape' => 'SecurityProfileSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'SecurityProfileSearchSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'SecurityProfileId', ], 'OrganizationResourceId' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], 'SecurityProfileName' => [ 'shape' => 'SecurityProfileName', ], 'Description' => [ 'shape' => 'SecurityProfileDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'SecurityProfileSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'SecurityProfileId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'SecurityProfileName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'SecurityProfileSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfileSummary', ], ], 'SecurityProfilesSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'SecurityProfilesSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfileSearchSummary', ], ], 'SecurityToken' => [ 'type' => 'string', 'sensitive' => true, ], 'SegmentAttributeName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'SegmentAttributeValue' => [ 'type' => 'structure', 'members' => [ 'ValueString' => [ 'shape' => 'SegmentAttributeValueString', ], ], ], 'SegmentAttributeValueString' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SegmentAttributes' => [ 'type' => 'map', 'key' => [ 'shape' => 'SegmentAttributeName', ], 'value' => [ 'shape' => 'SegmentAttributeValue', ], ], 'SendChatIntegrationEventRequest' => [ 'type' => 'structure', 'required' => [ 'SourceId', 'DestinationId', 'Event', ], 'members' => [ 'SourceId' => [ 'shape' => 'SourceId', ], 'DestinationId' => [ 'shape' => 'DestinationId', ], 'Subtype' => [ 'shape' => 'Subtype', ], 'Event' => [ 'shape' => 'ChatEvent', ], 'NewSessionDetails' => [ 'shape' => 'NewSessionDetails', ], ], ], 'SendChatIntegrationEventResponse' => [ 'type' => 'structure', 'members' => [ 'InitialContactId' => [ 'shape' => 'ContactId', ], 'NewChatCreated' => [ 'shape' => 'NewChatCreated', ], ], ], 'SendNotificationActionDefinition' => [ 'type' => 'structure', 'required' => [ 'DeliveryMethod', 'Content', 'ContentType', 'Recipient', ], 'members' => [ 'DeliveryMethod' => [ 'shape' => 'NotificationDeliveryType', ], 'Subject' => [ 'shape' => 'Subject', ], 'Content' => [ 'shape' => 'Content', ], 'ContentType' => [ 'shape' => 'NotificationContentType', ], 'Recipient' => [ 'shape' => 'NotificationRecipientType', ], ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 402, ], 'exception' => true, ], 'SignInConfig' => [ 'type' => 'structure', 'required' => [ 'Distributions', ], 'members' => [ 'Distributions' => [ 'shape' => 'SignInDistributionList', ], ], ], 'SignInDistribution' => [ 'type' => 'structure', 'required' => [ 'Region', 'Enabled', ], 'members' => [ 'Region' => [ 'shape' => 'AwsRegion', ], 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'SignInDistributionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SignInDistribution', ], ], 'SingleSelectOptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskTemplateSingleSelectOption', ], ], 'SingleSelectQuestionRuleCategoryAutomation' => [ 'type' => 'structure', 'required' => [ 'Category', 'Condition', 'OptionRefId', ], 'members' => [ 'Category' => [ 'shape' => 'SingleSelectQuestionRuleCategoryAutomationLabel', ], 'Condition' => [ 'shape' => 'SingleSelectQuestionRuleCategoryAutomationCondition', ], 'OptionRefId' => [ 'shape' => 'ReferenceId', ], ], ], 'SingleSelectQuestionRuleCategoryAutomationCondition' => [ 'type' => 'string', 'enum' => [ 'PRESENT', 'NOT_PRESENT', ], ], 'SingleSelectQuestionRuleCategoryAutomationLabel' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'SnapshotVersion' => [ 'type' => 'string', ], 'Sort' => [ 'type' => 'structure', 'required' => [ 'FieldName', 'Order', ], 'members' => [ 'FieldName' => [ 'shape' => 'SortableFieldName', ], 'Order' => [ 'shape' => 'SortOrder', ], ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'SortableFieldName' => [ 'type' => 'string', 'enum' => [ 'INITIATION_TIMESTAMP', 'SCHEDULED_TIMESTAMP', 'CONNECTED_TO_AGENT_TIMESTAMP', 'DISCONNECT_TIMESTAMP', 'INITIATION_METHOD', 'CHANNEL', ], ], 'SourceApplicationName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_ -]+$', ], 'SourceId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'SALESFORCE', 'ZENDESK', 'CASES', ], ], 'StartAttachedFileUploadRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FileName', 'FileSizeInBytes', 'FileUseCaseType', 'AssociatedResourceArn', ], 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FileName' => [ 'shape' => 'FileName', ], 'FileSizeInBytes' => [ 'shape' => 'FileSizeInBytes', 'box' => true, ], 'UrlExpiryInSeconds' => [ 'shape' => 'URLExpiryInSeconds', ], 'FileUseCaseType' => [ 'shape' => 'FileUseCaseType', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], 'CreatedBy' => [ 'shape' => 'CreatedByInfo', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'StartAttachedFileUploadResponse' => [ 'type' => 'structure', 'members' => [ 'FileArn' => [ 'shape' => 'ARN', ], 'FileId' => [ 'shape' => 'FileId', ], 'CreationTime' => [ 'shape' => 'ISO8601Datetime', ], 'FileStatus' => [ 'shape' => 'FileStatusType', ], 'CreatedBy' => [ 'shape' => 'CreatedByInfo', ], 'UploadUrlMetadata' => [ 'shape' => 'UploadUrlMetadata', ], ], ], 'StartChatContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', 'ParticipantDetails', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'ParticipantDetails' => [ 'shape' => 'ParticipantDetails', ], 'InitialMessage' => [ 'shape' => 'ChatMessage', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ChatDurationInMinutes' => [ 'shape' => 'ChatDurationInMinutes', ], 'SupportedMessagingContentTypes' => [ 'shape' => 'SupportedMessagingContentTypes', ], 'PersistentChat' => [ 'shape' => 'PersistentChat', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], 'SegmentAttributes' => [ 'shape' => 'SegmentAttributes', ], ], ], 'StartChatContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantToken' => [ 'shape' => 'ParticipantToken', ], 'ContinuedFromContactId' => [ 'shape' => 'ContactId', ], ], ], 'StartContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'EvaluationFormId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'StartContactEvaluationResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], ], ], 'StartContactRecordingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'InitialContactId', 'VoiceRecordingConfiguration', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], 'VoiceRecordingConfiguration' => [ 'shape' => 'VoiceRecordingConfiguration', ], ], ], 'StartContactRecordingResponse' => [ 'type' => 'structure', 'members' => [], ], 'StartContactStreamingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ChatStreamingConfiguration', 'ClientToken', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'ChatStreamingConfiguration' => [ 'shape' => 'ChatStreamingConfiguration', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'StartContactStreamingResponse' => [ 'type' => 'structure', 'required' => [ 'StreamingId', ], 'members' => [ 'StreamingId' => [ 'shape' => 'StreamingId', ], ], ], 'StartOutboundVoiceContactRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', 'ContactFlowId', 'InstanceId', ], 'members' => [ 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'References' => [ 'shape' => 'ContactReferences', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'SourcePhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'QueueId' => [ 'shape' => 'QueueId', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'AnswerMachineDetectionConfig' => [ 'shape' => 'AnswerMachineDetectionConfig', ], 'CampaignId' => [ 'shape' => 'CampaignId', ], 'TrafficType' => [ 'shape' => 'TrafficType', ], ], ], 'StartOutboundVoiceContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], ], ], 'StartTaskContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'PreviousContactId' => [ 'shape' => 'ContactId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'Name' => [ 'shape' => 'Name', ], 'References' => [ 'shape' => 'ContactReferences', ], 'Description' => [ 'shape' => 'Description', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], 'TaskTemplateId' => [ 'shape' => 'TaskTemplateId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], ], ], 'StartTaskContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], ], ], 'StartWebRTCContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactFlowId', 'InstanceId', 'ParticipantDetails', ], 'members' => [ 'Attributes' => [ 'shape' => 'Attributes', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'AllowedCapabilities' => [ 'shape' => 'AllowedCapabilities', ], 'ParticipantDetails' => [ 'shape' => 'ParticipantDetails', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], 'References' => [ 'shape' => 'ContactReferences', ], 'Description' => [ 'shape' => 'Description', ], ], ], 'StartWebRTCContactResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectionData' => [ 'shape' => 'ConnectionData', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantToken' => [ 'shape' => 'ParticipantToken', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'SUM', 'MAX', 'AVG', ], ], 'Step' => [ 'type' => 'structure', 'members' => [ 'Expiry' => [ 'shape' => 'Expiry', ], 'Expression' => [ 'shape' => 'Expression', ], 'Status' => [ 'shape' => 'RoutingCriteriaStepStatus', ], ], ], 'Steps' => [ 'type' => 'list', 'member' => [ 'shape' => 'Step', ], ], 'StopContactRecordingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'InitialContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], ], ], 'StopContactRecordingResponse' => [ 'type' => 'structure', 'members' => [], ], 'StopContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'DisconnectReason' => [ 'shape' => 'DisconnectReason', ], ], ], 'StopContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'StopContactStreamingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'StreamingId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'StreamingId' => [ 'shape' => 'StreamingId', ], ], ], 'StopContactStreamingResponse' => [ 'type' => 'structure', 'members' => [], ], 'StorageType' => [ 'type' => 'string', 'enum' => [ 'S3', 'KINESIS_VIDEO_STREAM', 'KINESIS_STREAM', 'KINESIS_FIREHOSE', ], ], 'StreamingId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'String' => [ 'type' => 'string', ], 'StringComparisonType' => [ 'type' => 'string', 'enum' => [ 'STARTS_WITH', 'CONTAINS', 'EXACT', ], ], 'StringCondition' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], 'ComparisonType' => [ 'shape' => 'StringComparisonType', ], ], ], 'StringReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'Subject' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'SubmitAutoEvaluationActionDefinition' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'EvaluationFormId', ], ], ], 'SubmitContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationId', ], 'Answers' => [ 'shape' => 'EvaluationAnswersInputMap', ], 'Notes' => [ 'shape' => 'EvaluationNotesMap', ], ], ], 'SubmitContactEvaluationResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], ], ], 'Subtype' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'SuccessfulRequest' => [ 'type' => 'structure', 'members' => [ 'RequestIdentifier' => [ 'shape' => 'RequestIdentifier', ], 'ContactId' => [ 'shape' => 'ContactId', ], ], ], 'SuccessfulRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessfulRequest', ], ], 'SupportedMessagingContentType' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'SupportedMessagingContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'SupportedMessagingContentType', ], ], 'SuspendContactRecordingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'InitialContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], ], ], 'SuspendContactRecordingResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagAndConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagCondition', ], ], 'TagCondition' => [ 'type' => 'structure', 'members' => [ 'TagKey' => [ 'shape' => 'String', ], 'TagValue' => [ 'shape' => 'String', ], ], ], 'TagContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', 'Tags', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Tags' => [ 'shape' => 'ContactTagMap', ], ], ], 'TagContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^(?!aws:)[a-zA-Z+-=._:/]+$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagKeyString' => [ 'type' => 'string', 'max' => 128, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 50, 'min' => 1, ], 'TagOrConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagAndConditionList', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagRestrictedResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagRestrictedResourceName', ], 'max' => 10, ], 'TagRestrictedResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagSearchCondition' => [ 'type' => 'structure', 'members' => [ 'tagKey' => [ 'shape' => 'TagKeyString', ], 'tagValue' => [ 'shape' => 'TagValueString', ], 'tagKeyComparisonType' => [ 'shape' => 'StringComparisonType', ], 'tagValueComparisonType' => [ 'shape' => 'StringComparisonType', ], ], ], 'TagSet' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, ], 'TagValueString' => [ 'type' => 'string', 'max' => 256, ], 'TagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagSet', ], ], 'TaskActionDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'ContactFlowId', ], 'members' => [ 'Name' => [ 'shape' => 'TaskNameExpression', ], 'Description' => [ 'shape' => 'TaskDescriptionExpression', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'References' => [ 'shape' => 'ContactReferences', ], ], ], 'TaskDescriptionExpression' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, ], 'TaskNameExpression' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'TaskTemplateArn' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'TaskTemplateConstraints' => [ 'type' => 'structure', 'members' => [ 'RequiredFields' => [ 'shape' => 'RequiredTaskTemplateFields', ], 'ReadOnlyFields' => [ 'shape' => 'ReadOnlyTaskTemplateFields', ], 'InvisibleFields' => [ 'shape' => 'InvisibleTaskTemplateFields', ], ], ], 'TaskTemplateDefaultFieldValue' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], 'DefaultValue' => [ 'shape' => 'TaskTemplateFieldValue', ], ], ], 'TaskTemplateDefaultFieldValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskTemplateDefaultFieldValue', ], ], 'TaskTemplateDefaults' => [ 'type' => 'structure', 'members' => [ 'DefaultFieldValues' => [ 'shape' => 'TaskTemplateDefaultFieldValueList', ], ], ], 'TaskTemplateDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'TaskTemplateField' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], 'Description' => [ 'shape' => 'TaskTemplateFieldDescription', ], 'Type' => [ 'shape' => 'TaskTemplateFieldType', ], 'SingleSelectOptions' => [ 'shape' => 'SingleSelectOptions', ], ], ], 'TaskTemplateFieldDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'TaskTemplateFieldIdentifier' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'TaskTemplateFieldName', ], ], ], 'TaskTemplateFieldName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'TaskTemplateFieldType' => [ 'type' => 'string', 'enum' => [ 'NAME', 'DESCRIPTION', 'SCHEDULED_TIME', 'QUICK_CONNECT', 'URL', 'NUMBER', 'TEXT', 'TEXT_AREA', 'DATE_TIME', 'BOOLEAN', 'SINGLE_SELECT', 'EMAIL', ], ], 'TaskTemplateFieldValue' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, ], 'TaskTemplateFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskTemplateField', ], ], 'TaskTemplateId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'TaskTemplateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskTemplateMetadata', ], ], 'TaskTemplateMetadata' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateId', ], 'Arn' => [ 'shape' => 'TaskTemplateArn', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'LastModifiedTime' => [ 'shape' => 'timestamp', ], 'CreatedTime' => [ 'shape' => 'timestamp', ], ], ], 'TaskTemplateName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'TaskTemplateSingleSelectOption' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'TaskTemplateStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'TelephonyConfig' => [ 'type' => 'structure', 'required' => [ 'Distributions', ], 'members' => [ 'Distributions' => [ 'shape' => 'DistributionList', ], ], ], 'TemplateId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'Threshold' => [ 'type' => 'structure', 'members' => [ 'Comparison' => [ 'shape' => 'Comparison', ], 'ThresholdValue' => [ 'shape' => 'ThresholdValue', 'box' => true, ], ], ], 'ThresholdCollections' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThresholdV2', ], 'max' => 1, ], 'ThresholdV2' => [ 'type' => 'structure', 'members' => [ 'Comparison' => [ 'shape' => 'ResourceArnOrId', ], 'ThresholdValue' => [ 'shape' => 'ThresholdValue', 'box' => true, ], ], ], 'ThresholdValue' => [ 'type' => 'double', ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TimeZone' => [ 'type' => 'string', ], 'TimerEligibleParticipantRoles' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'AGENT', ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TotalCount' => [ 'type' => 'long', ], 'TotalPauseCount' => [ 'type' => 'integer', 'max' => 10, 'min' => 0, ], 'TotalPauseDurationInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'TrafficDistributionGroup' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupId', ], 'Arn' => [ 'shape' => 'TrafficDistributionGroupArn', ], 'Name' => [ 'shape' => 'Name128', ], 'Description' => [ 'shape' => 'Description250', ], 'InstanceArn' => [ 'shape' => 'InstanceArn', ], 'Status' => [ 'shape' => 'TrafficDistributionGroupStatus', ], 'Tags' => [ 'shape' => 'TagMap', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'TrafficDistributionGroupArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'TrafficDistributionGroupId' => [ 'type' => 'string', 'pattern' => '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'TrafficDistributionGroupIdOrArn' => [ 'type' => 'string', 'pattern' => '^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'TrafficDistributionGroupStatus' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'ACTIVE', 'CREATION_FAILED', 'PENDING_DELETION', 'DELETION_FAILED', 'UPDATE_IN_PROGRESS', ], ], 'TrafficDistributionGroupSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupId', ], 'Arn' => [ 'shape' => 'TrafficDistributionGroupArn', ], 'Name' => [ 'shape' => 'Name128', ], 'InstanceArn' => [ 'shape' => 'InstanceArn', ], 'Status' => [ 'shape' => 'TrafficDistributionGroupStatus', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'TrafficDistributionGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrafficDistributionGroupSummary', ], 'max' => 10, 'min' => 0, ], 'TrafficDistributionGroupUserSummary' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], ], ], 'TrafficDistributionGroupUserSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrafficDistributionGroupUserSummary', ], 'max' => 10, 'min' => 0, ], 'TrafficType' => [ 'type' => 'string', 'enum' => [ 'GENERAL', 'CAMPAIGN', ], ], 'Transcript' => [ 'type' => 'structure', 'required' => [ 'Criteria', ], 'members' => [ 'Criteria' => [ 'shape' => 'TranscriptCriteriaList', ], 'MatchType' => [ 'shape' => 'SearchContactsMatchType', ], ], ], 'TranscriptCriteria' => [ 'type' => 'structure', 'required' => [ 'ParticipantRole', 'SearchText', 'MatchType', ], 'members' => [ 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'SearchText' => [ 'shape' => 'SearchTextList', ], 'MatchType' => [ 'shape' => 'SearchContactsMatchType', ], ], ], 'TranscriptCriteriaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TranscriptCriteria', ], 'max' => 6, 'min' => 0, ], 'TransferContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'QueueId' => [ 'shape' => 'QueueId', ], 'UserId' => [ 'shape' => 'AgentResourceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'TransferContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'ContactArn' => [ 'shape' => 'ARN', ], ], ], 'URI' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, ], 'URLExpiryInSeconds' => [ 'type' => 'integer', 'max' => 300, 'min' => 5, ], 'Unit' => [ 'type' => 'string', 'enum' => [ 'SECONDS', 'COUNT', 'PERCENT', ], ], 'UntagContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', 'TagKeys', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'TagKeys' => [ 'shape' => 'ContactTagKeys', 'location' => 'querystring', 'locationName' => 'TagKeys', ], ], ], 'UntagContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UpdateAgentStatusDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 0, ], 'UpdateAgentStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AgentStatusId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', 'location' => 'uri', 'locationName' => 'AgentStatusId', ], 'Name' => [ 'shape' => 'AgentStatusName', ], 'Description' => [ 'shape' => 'UpdateAgentStatusDescription', ], 'State' => [ 'shape' => 'AgentStatusState', ], 'DisplayOrder' => [ 'shape' => 'AgentStatusOrderNumber', 'box' => true, ], 'ResetOrderNumber' => [ 'shape' => 'Boolean', ], ], ], 'UpdateCaseActionDefinition' => [ 'type' => 'structure', 'required' => [ 'Fields', ], 'members' => [ 'Fields' => [ 'shape' => 'FieldValues', ], ], ], 'UpdateContactAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InitialContactId', 'InstanceId', 'Attributes', ], 'members' => [ 'InitialContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Attributes' => [ 'shape' => 'Attributes', ], ], ], 'UpdateContactAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationId', ], 'Answers' => [ 'shape' => 'EvaluationAnswersInputMap', ], 'Notes' => [ 'shape' => 'EvaluationNotesMap', ], ], ], 'UpdateContactEvaluationResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], ], ], 'UpdateContactFlowContentRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], 'Content' => [ 'shape' => 'ContactFlowContent', ], ], ], 'UpdateContactFlowContentResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactFlowMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'Description' => [ 'shape' => 'ContactFlowDescription', ], 'ContactFlowState' => [ 'shape' => 'ContactFlowState', ], ], ], 'UpdateContactFlowMetadataResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactFlowModuleContentRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowModuleId', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowModuleId' => [ 'shape' => 'ContactFlowModuleId', 'location' => 'uri', 'locationName' => 'ContactFlowModuleId', ], 'Content' => [ 'shape' => 'ContactFlowModuleContent', ], ], ], 'UpdateContactFlowModuleContentResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactFlowModuleMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowModuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowModuleId' => [ 'shape' => 'ContactFlowModuleId', 'location' => 'uri', 'locationName' => 'ContactFlowModuleId', ], 'Name' => [ 'shape' => 'ContactFlowModuleName', ], 'Description' => [ 'shape' => 'ContactFlowModuleDescription', ], 'State' => [ 'shape' => 'ContactFlowModuleState', ], ], ], 'UpdateContactFlowModuleMetadataResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactFlowNameRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'Description' => [ 'shape' => 'ContactFlowDescription', ], ], ], 'UpdateContactFlowNameResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'References' => [ 'shape' => 'ContactReferences', ], ], ], 'UpdateContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactRoutingDataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'QueueTimeAdjustmentSeconds' => [ 'shape' => 'QueueTimeAdjustmentSeconds', ], 'QueuePriority' => [ 'shape' => 'QueuePriority', ], ], ], 'UpdateContactRoutingDataResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ScheduledTime', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], ], ], 'UpdateContactScheduleResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', 'EvaluationFormVersion', 'Title', 'Items', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], 'CreateNewVersion' => [ 'shape' => 'BoxedBoolean', 'box' => true, ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'Description' => [ 'shape' => 'EvaluationFormDescription', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'ScoringStrategy' => [ 'shape' => 'EvaluationFormScoringStrategy', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'UpdateEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', 'EvaluationFormVersion', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'UpdateHoursOfOperationDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 0, ], 'UpdateHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', 'location' => 'uri', 'locationName' => 'HoursOfOperationId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'UpdateHoursOfOperationDescription', ], 'TimeZone' => [ 'shape' => 'TimeZone', ], 'Config' => [ 'shape' => 'HoursOfOperationConfigList', ], ], ], 'UpdateInstanceAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AttributeType', 'Value', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AttributeType' => [ 'shape' => 'InstanceAttributeType', 'location' => 'uri', 'locationName' => 'AttributeType', ], 'Value' => [ 'shape' => 'InstanceAttributeValue', ], ], ], 'UpdateInstanceStorageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AssociationId', 'ResourceType', 'StorageConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociationId' => [ 'shape' => 'AssociationId', 'location' => 'uri', 'locationName' => 'AssociationId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'StorageConfig' => [ 'shape' => 'InstanceStorageConfig', ], ], ], 'UpdateParticipantRoleConfigChannelInfo' => [ 'type' => 'structure', 'members' => [ 'Chat' => [ 'shape' => 'ChatParticipantRoleConfig', ], ], 'union' => true, ], 'UpdateParticipantRoleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ChannelConfiguration', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'ChannelConfiguration' => [ 'shape' => 'UpdateParticipantRoleConfigChannelInfo', ], ], ], 'UpdateParticipantRoleConfigResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePhoneNumberMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'UpdatePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'UpdatePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'UpdatePredefinedAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'PredefinedAttributeName', 'location' => 'uri', 'locationName' => 'Name', ], 'Values' => [ 'shape' => 'PredefinedAttributeValues', ], ], ], 'UpdatePromptRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'PromptId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PromptId' => [ 'shape' => 'PromptId', 'location' => 'uri', 'locationName' => 'PromptId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'PromptDescription', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'UpdatePromptResponse' => [ 'type' => 'structure', 'members' => [ 'PromptARN' => [ 'shape' => 'ARN', ], 'PromptId' => [ 'shape' => 'PromptId', ], ], ], 'UpdateQueueHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], ], ], 'UpdateQueueMaxContactsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'MaxContacts' => [ 'shape' => 'QueueMaxContacts', 'box' => true, ], ], ], 'UpdateQueueNameRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'QueueDescription', ], ], ], 'UpdateQueueOutboundCallerConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'OutboundCallerConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'OutboundCallerConfig' => [ 'shape' => 'OutboundCallerConfig', ], ], ], 'UpdateQueueStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'Status', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'Status' => [ 'shape' => 'QueueStatus', ], ], ], 'UpdateQuickConnectConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QuickConnectId', 'QuickConnectConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', 'location' => 'uri', 'locationName' => 'QuickConnectId', ], 'QuickConnectConfig' => [ 'shape' => 'QuickConnectConfig', ], ], ], 'UpdateQuickConnectDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 0, ], 'UpdateQuickConnectNameRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QuickConnectId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', 'location' => 'uri', 'locationName' => 'QuickConnectId', ], 'Name' => [ 'shape' => 'QuickConnectName', ], 'Description' => [ 'shape' => 'UpdateQuickConnectDescription', ], ], ], 'UpdateRoutingProfileAgentAvailabilityTimerRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'AgentAvailabilityTimer', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'AgentAvailabilityTimer' => [ 'shape' => 'AgentAvailabilityTimer', ], ], ], 'UpdateRoutingProfileConcurrencyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'MediaConcurrencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'MediaConcurrencies' => [ 'shape' => 'MediaConcurrencies', ], ], ], 'UpdateRoutingProfileDefaultOutboundQueueRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'DefaultOutboundQueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'DefaultOutboundQueueId' => [ 'shape' => 'QueueId', ], ], ], 'UpdateRoutingProfileNameRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'Name' => [ 'shape' => 'RoutingProfileName', ], 'Description' => [ 'shape' => 'RoutingProfileDescription', ], ], ], 'UpdateRoutingProfileQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'QueueConfigs', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'QueueConfigs' => [ 'shape' => 'RoutingProfileQueueConfigList', ], ], ], 'UpdateRuleRequest' => [ 'type' => 'structure', 'required' => [ 'RuleId', 'InstanceId', 'Name', 'Function', 'Actions', 'PublishStatus', ], 'members' => [ 'RuleId' => [ 'shape' => 'RuleId', 'location' => 'uri', 'locationName' => 'RuleId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'RuleName', ], 'Function' => [ 'shape' => 'RuleFunction', ], 'Actions' => [ 'shape' => 'RuleActions', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', ], ], ], 'UpdateSecurityProfileRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileId', 'InstanceId', ], 'members' => [ 'Description' => [ 'shape' => 'SecurityProfileDescription', ], 'Permissions' => [ 'shape' => 'PermissionsList', ], 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AllowedAccessControlTags' => [ 'shape' => 'AllowedAccessControlTags', ], 'TagRestrictedResources' => [ 'shape' => 'TagRestrictedResourceList', ], 'Applications' => [ 'shape' => 'Applications', ], 'HierarchyRestrictedResources' => [ 'shape' => 'HierarchyRestrictedResourceList', ], 'AllowedAccessControlHierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], ], ], 'UpdateTaskTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'TaskTemplateId', 'InstanceId', ], 'members' => [ 'TaskTemplateId' => [ 'shape' => 'TaskTemplateId', 'location' => 'uri', 'locationName' => 'TaskTemplateId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Constraints' => [ 'shape' => 'TaskTemplateConstraints', ], 'Defaults' => [ 'shape' => 'TaskTemplateDefaults', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'Fields' => [ 'shape' => 'TaskTemplateFields', ], ], ], 'UpdateTaskTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Id' => [ 'shape' => 'TaskTemplateId', ], 'Arn' => [ 'shape' => 'TaskTemplateArn', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Constraints' => [ 'shape' => 'TaskTemplateConstraints', ], 'Defaults' => [ 'shape' => 'TaskTemplateDefaults', ], 'Fields' => [ 'shape' => 'TaskTemplateFields', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'LastModifiedTime' => [ 'shape' => 'timestamp', ], 'CreatedTime' => [ 'shape' => 'timestamp', ], ], ], 'UpdateTrafficDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'Id', ], 'TelephonyConfig' => [ 'shape' => 'TelephonyConfig', ], 'SignInConfig' => [ 'shape' => 'SignInConfig', ], 'AgentConfig' => [ 'shape' => 'AgentConfig', ], ], ], 'UpdateTrafficDistributionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateUserHierarchyGroupNameRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'HierarchyGroupId', 'InstanceId', ], 'members' => [ 'Name' => [ 'shape' => 'HierarchyGroupName', ], 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', 'location' => 'uri', 'locationName' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserHierarchyRequest' => [ 'type' => 'structure', 'required' => [ 'UserId', 'InstanceId', ], 'members' => [ 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserHierarchyStructureRequest' => [ 'type' => 'structure', 'required' => [ 'HierarchyStructure', 'InstanceId', ], 'members' => [ 'HierarchyStructure' => [ 'shape' => 'HierarchyStructureUpdate', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserIdentityInfoRequest' => [ 'type' => 'structure', 'required' => [ 'IdentityInfo', 'UserId', 'InstanceId', ], 'members' => [ 'IdentityInfo' => [ 'shape' => 'UserIdentityInfo', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserPhoneConfigRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneConfig', 'UserId', 'InstanceId', ], 'members' => [ 'PhoneConfig' => [ 'shape' => 'UserPhoneConfig', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserProficienciesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', 'UserProficiencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'UserProficiencies' => [ 'shape' => 'UserProficiencyList', ], ], ], 'UpdateUserRoutingProfileRequest' => [ 'type' => 'structure', 'required' => [ 'RoutingProfileId', 'UserId', 'InstanceId', ], 'members' => [ 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserSecurityProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileIds', 'UserId', 'InstanceId', ], 'members' => [ 'SecurityProfileIds' => [ 'shape' => 'SecurityProfileIds', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateViewContentRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', 'Status', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'Status' => [ 'shape' => 'ViewStatus', ], 'Content' => [ 'shape' => 'ViewInputContent', ], ], ], 'UpdateViewContentResponse' => [ 'type' => 'structure', 'members' => [ 'View' => [ 'shape' => 'View', ], ], ], 'UpdateViewMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'Name' => [ 'shape' => 'ViewName', ], 'Description' => [ 'shape' => 'ViewDescription', ], ], ], 'UpdateViewMetadataResponse' => [ 'type' => 'structure', 'members' => [], ], 'UploadUrlMetadata' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'MetadataUrl', ], 'UrlExpiry' => [ 'shape' => 'ISO8601Datetime', ], 'HeadersToInclude' => [ 'shape' => 'UrlMetadataSignedHeaders', ], ], ], 'Url' => [ 'type' => 'string', ], 'UrlMetadataSignedHeaders' => [ 'type' => 'map', 'key' => [ 'shape' => 'UrlMetadataSignedHeadersKey', ], 'value' => [ 'shape' => 'UrlMetadataSignedHeadersValue', ], ], 'UrlMetadataSignedHeadersKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'UrlMetadataSignedHeadersValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'UrlReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'UseCase' => [ 'type' => 'structure', 'members' => [ 'UseCaseId' => [ 'shape' => 'UseCaseId', ], 'UseCaseArn' => [ 'shape' => 'ARN', ], 'UseCaseType' => [ 'shape' => 'UseCaseType', ], ], ], 'UseCaseId' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'UseCaseSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UseCase', ], ], 'UseCaseType' => [ 'type' => 'string', 'enum' => [ 'RULES_EVALUATION', 'CONNECT_CAMPAIGNS', ], ], 'User' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Username' => [ 'shape' => 'AgentUsername', ], 'IdentityInfo' => [ 'shape' => 'UserIdentityInfo', ], 'PhoneConfig' => [ 'shape' => 'UserPhoneConfig', ], 'DirectoryUserId' => [ 'shape' => 'DirectoryUserId', ], 'SecurityProfileIds' => [ 'shape' => 'SecurityProfileIds', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'UserData' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'UserReference', ], 'RoutingProfile' => [ 'shape' => 'RoutingProfileReference', ], 'HierarchyPath' => [ 'shape' => 'HierarchyPathReference', ], 'Status' => [ 'shape' => 'AgentStatusReference', ], 'AvailableSlotsByChannel' => [ 'shape' => 'ChannelToCountMap', ], 'MaxSlotsByChannel' => [ 'shape' => 'ChannelToCountMap', ], 'ActiveSlotsByChannel' => [ 'shape' => 'ChannelToCountMap', ], 'Contacts' => [ 'shape' => 'AgentContactReferenceList', ], 'NextStatus' => [ 'shape' => 'AgentStatusName', ], ], ], 'UserDataFilters' => [ 'type' => 'structure', 'members' => [ 'Queues' => [ 'shape' => 'Queues', ], 'ContactFilter' => [ 'shape' => 'ContactFilter', ], 'RoutingProfiles' => [ 'shape' => 'RoutingProfiles', ], 'Agents' => [ 'shape' => 'AgentsMinOneMaxHundred', ], 'UserHierarchyGroups' => [ 'shape' => 'UserDataHierarchyGroups', ], ], ], 'UserDataHierarchyGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'HierarchyGroupId', ], 'max' => 1, 'min' => 1, ], 'UserDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserData', ], ], 'UserId' => [ 'type' => 'string', ], 'UserIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserId', ], ], 'UserIdentityInfo' => [ 'type' => 'structure', 'members' => [ 'FirstName' => [ 'shape' => 'AgentFirstName', ], 'LastName' => [ 'shape' => 'AgentLastName', ], 'Email' => [ 'shape' => 'Email', ], 'SecondaryEmail' => [ 'shape' => 'Email', ], 'Mobile' => [ 'shape' => 'PhoneNumber', ], ], ], 'UserIdentityInfoLite' => [ 'type' => 'structure', 'members' => [ 'FirstName' => [ 'shape' => 'AgentFirstName', ], 'LastName' => [ 'shape' => 'AgentLastName', ], ], ], 'UserNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'UserPhoneConfig' => [ 'type' => 'structure', 'required' => [ 'PhoneType', ], 'members' => [ 'PhoneType' => [ 'shape' => 'PhoneType', ], 'AutoAccept' => [ 'shape' => 'AutoAccept', ], 'AfterContactWorkTimeLimit' => [ 'shape' => 'AfterContactWorkTimeLimit', ], 'DeskPhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'UserProficiency' => [ 'type' => 'structure', 'required' => [ 'AttributeName', 'AttributeValue', 'Level', ], 'members' => [ 'AttributeName' => [ 'shape' => 'PredefinedAttributeName', ], 'AttributeValue' => [ 'shape' => 'PredefinedAttributeStringValue', ], 'Level' => [ 'shape' => 'ProficiencyLevel', ], ], ], 'UserProficiencyDisassociate' => [ 'type' => 'structure', 'required' => [ 'AttributeName', 'AttributeValue', ], 'members' => [ 'AttributeName' => [ 'shape' => 'PredefinedAttributeName', ], 'AttributeValue' => [ 'shape' => 'PredefinedAttributeStringValue', ], ], ], 'UserProficiencyDisassociateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProficiencyDisassociate', ], ], 'UserProficiencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProficiency', ], ], 'UserQuickConnectConfig' => [ 'type' => 'structure', 'required' => [ 'UserId', 'ContactFlowId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'UserReference' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'UserSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserSearchCriteria', ], ], 'UserSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'UserSearchConditionList', ], 'AndConditions' => [ 'shape' => 'UserSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], 'HierarchyGroupCondition' => [ 'shape' => 'HierarchyGroupCondition', ], ], ], 'UserSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], 'UserAttributeFilter' => [ 'shape' => 'ControlPlaneUserAttributeFilter', ], ], ], 'UserSearchSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'DirectoryUserId' => [ 'shape' => 'DirectoryUserId', ], 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'Id' => [ 'shape' => 'UserId', ], 'IdentityInfo' => [ 'shape' => 'UserIdentityInfoLite', ], 'PhoneConfig' => [ 'shape' => 'UserPhoneConfig', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'SecurityProfileIds' => [ 'shape' => 'SecurityProfileIds', ], 'Tags' => [ 'shape' => 'TagMap', ], 'Username' => [ 'shape' => 'AgentUsername', ], ], ], 'UserSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserSearchSummary', ], ], 'UserSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Username' => [ 'shape' => 'AgentUsername', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'UserSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserSummary', ], ], 'UserTagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'Value' => [ 'type' => 'double', ], 'VersionNumber' => [ 'type' => 'integer', 'min' => 1, ], 'VideoCapability' => [ 'type' => 'string', 'enum' => [ 'SEND', ], ], 'View' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ViewId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'ViewName', ], 'Status' => [ 'shape' => 'ViewStatus', ], 'Type' => [ 'shape' => 'ViewType', ], 'Description' => [ 'shape' => 'ViewDescription', ], 'Version' => [ 'shape' => 'ViewVersion', ], 'VersionDescription' => [ 'shape' => 'ViewDescription', ], 'Content' => [ 'shape' => 'ViewContent', ], 'Tags' => [ 'shape' => 'TagMap', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ViewContentSha256' => [ 'shape' => 'ViewContentSha256', ], ], ], 'ViewAction' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{N}_.:\\/=+\\-@()\']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()\']*)$', 'sensitive' => true, ], 'ViewActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ViewAction', ], ], 'ViewContent' => [ 'type' => 'structure', 'members' => [ 'InputSchema' => [ 'shape' => 'ViewInputSchema', ], 'Template' => [ 'shape' => 'ViewTemplate', ], 'Actions' => [ 'shape' => 'ViewActions', ], ], ], 'ViewContentSha256' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]$', ], 'ViewDescription' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^([\\p{L}\\p{N}_.:\\/=+\\-@,()\']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@,()\']*)$', ], 'ViewId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-:\\/$]+$', ], 'ViewInputContent' => [ 'type' => 'structure', 'members' => [ 'Template' => [ 'shape' => 'ViewTemplate', ], 'Actions' => [ 'shape' => 'ViewActions', ], ], ], 'ViewInputSchema' => [ 'type' => 'string', 'sensitive' => true, ], 'ViewName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{N}_.:\\/=+\\-@()\']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()\']*)$', 'sensitive' => true, ], 'ViewStatus' => [ 'type' => 'string', 'enum' => [ 'PUBLISHED', 'SAVED', ], ], 'ViewSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ViewId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'ViewName', ], 'Type' => [ 'shape' => 'ViewType', ], 'Status' => [ 'shape' => 'ViewStatus', ], 'Description' => [ 'shape' => 'ViewDescription', ], ], ], 'ViewTemplate' => [ 'type' => 'string', ], 'ViewType' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER_MANAGED', 'AWS_MANAGED', ], ], 'ViewVersion' => [ 'type' => 'integer', ], 'ViewVersionSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ViewId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Description' => [ 'shape' => 'ViewDescription', ], 'Name' => [ 'shape' => 'ViewName', ], 'Type' => [ 'shape' => 'ViewType', ], 'Version' => [ 'shape' => 'ViewVersion', ], 'VersionDescription' => [ 'shape' => 'ViewDescription', ], ], ], 'ViewVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ViewVersionSummary', ], ], 'ViewsClientToken' => [ 'type' => 'string', 'max' => 500, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$', ], 'ViewsInstanceId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-:\\/]+$', ], 'ViewsNextToken' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^[a-zA-Z0-9=\\/+_.-]+$', ], 'ViewsSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ViewSummary', ], ], 'Vocabulary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'Arn', 'LanguageCode', 'State', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'VocabularyName', ], 'Id' => [ 'shape' => 'VocabularyId', ], 'Arn' => [ 'shape' => 'ARN', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'State' => [ 'shape' => 'VocabularyState', ], 'LastModifiedTime' => [ 'shape' => 'VocabularyLastModifiedTime', ], 'FailureReason' => [ 'shape' => 'VocabularyFailureReason', ], 'Content' => [ 'shape' => 'VocabularyContent', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'VocabularyContent' => [ 'type' => 'string', 'max' => 60000, 'min' => 1, ], 'VocabularyFailureReason' => [ 'type' => 'string', ], 'VocabularyId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'VocabularyLanguageCode' => [ 'type' => 'string', 'enum' => [ 'ar-AE', 'de-CH', 'de-DE', 'en-AB', 'en-AU', 'en-GB', 'en-IE', 'en-IN', 'en-US', 'en-WL', 'es-ES', 'es-US', 'fr-CA', 'fr-FR', 'hi-IN', 'it-IT', 'ja-JP', 'ko-KR', 'pt-BR', 'pt-PT', 'zh-CN', 'en-NZ', 'en-ZA', ], ], 'VocabularyLastModifiedTime' => [ 'type' => 'timestamp', ], 'VocabularyName' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '^[0-9a-zA-Z._-]+', ], 'VocabularyNextToken' => [ 'type' => 'string', 'max' => 131070, 'min' => 1, 'pattern' => '.*\\S.*', ], 'VocabularyState' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'ACTIVE', 'CREATION_FAILED', 'DELETE_IN_PROGRESS', ], ], 'VocabularySummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'Arn', 'LanguageCode', 'State', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'VocabularyName', ], 'Id' => [ 'shape' => 'VocabularyId', ], 'Arn' => [ 'shape' => 'ARN', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'State' => [ 'shape' => 'VocabularyState', ], 'LastModifiedTime' => [ 'shape' => 'VocabularyLastModifiedTime', ], 'FailureReason' => [ 'shape' => 'VocabularyFailureReason', ], ], ], 'VocabularySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VocabularySummary', ], ], 'VoiceRecordingConfiguration' => [ 'type' => 'structure', 'members' => [ 'VoiceRecordingTrack' => [ 'shape' => 'VoiceRecordingTrack', ], ], ], 'VoiceRecordingTrack' => [ 'type' => 'string', 'enum' => [ 'FROM_AGENT', 'TO_AGENT', 'ALL', ], ], 'WisdomInfo' => [ 'type' => 'structure', 'members' => [ 'SessionArn' => [ 'shape' => 'ARN', ], ], ], 'resourceArnListMaxLimit100' => [ 'type' => 'list', 'member' => [ 'shape' => 'ARN', ], 'max' => 100, 'min' => 1, ], 'timestamp' => [ 'type' => 'timestamp', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2017-08-08', 'endpointPrefix' => 'connect', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceAbbreviation' => 'Amazon Connect', 'serviceFullName' => 'Amazon Connect Service', 'serviceId' => 'Connect', 'signatureVersion' => 'v4', 'signingName' => 'connect', 'uid' => 'connect-2017-08-08', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'ActivateEvaluationForm' => [ 'name' => 'ActivateEvaluationForm', 'http' => [ 'method' => 'POST', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}/activate', ], 'input' => [ 'shape' => 'ActivateEvaluationFormRequest', ], 'output' => [ 'shape' => 'ActivateEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'AssociateAnalyticsDataSet' => [ 'name' => 'AssociateAnalyticsDataSet', 'http' => [ 'method' => 'PUT', 'requestUri' => '/analytics-data/instance/{InstanceId}/association', ], 'input' => [ 'shape' => 'AssociateAnalyticsDataSetRequest', ], 'output' => [ 'shape' => 'AssociateAnalyticsDataSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'AssociateApprovedOrigin' => [ 'name' => 'AssociateApprovedOrigin', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/approved-origin', ], 'input' => [ 'shape' => 'AssociateApprovedOriginRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateBot' => [ 'name' => 'AssociateBot', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/bot', ], 'input' => [ 'shape' => 'AssociateBotRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateDefaultVocabulary' => [ 'name' => 'AssociateDefaultVocabulary', 'http' => [ 'method' => 'PUT', 'requestUri' => '/default-vocabulary/{InstanceId}/{LanguageCode}', ], 'input' => [ 'shape' => 'AssociateDefaultVocabularyRequest', ], 'output' => [ 'shape' => 'AssociateDefaultVocabularyResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'AssociateFlow' => [ 'name' => 'AssociateFlow', 'http' => [ 'method' => 'PUT', 'requestUri' => '/flow-associations/{InstanceId}', ], 'input' => [ 'shape' => 'AssociateFlowRequest', ], 'output' => [ 'shape' => 'AssociateFlowResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateInstanceStorageConfig' => [ 'name' => 'AssociateInstanceStorageConfig', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/storage-config', ], 'input' => [ 'shape' => 'AssociateInstanceStorageConfigRequest', ], 'output' => [ 'shape' => 'AssociateInstanceStorageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateLambdaFunction' => [ 'name' => 'AssociateLambdaFunction', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/lambda-function', ], 'input' => [ 'shape' => 'AssociateLambdaFunctionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateLexBot' => [ 'name' => 'AssociateLexBot', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/lex-bot', ], 'input' => [ 'shape' => 'AssociateLexBotRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociatePhoneNumberContactFlow' => [ 'name' => 'AssociatePhoneNumberContactFlow', 'http' => [ 'method' => 'PUT', 'requestUri' => '/phone-number/{PhoneNumberId}/contact-flow', ], 'input' => [ 'shape' => 'AssociatePhoneNumberContactFlowRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'AssociateQueueQuickConnects' => [ 'name' => 'AssociateQueueQuickConnects', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/associate-quick-connects', ], 'input' => [ 'shape' => 'AssociateQueueQuickConnectsRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'AssociateRoutingProfileQueues' => [ 'name' => 'AssociateRoutingProfileQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues', ], 'input' => [ 'shape' => 'AssociateRoutingProfileQueuesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'AssociateSecurityKey' => [ 'name' => 'AssociateSecurityKey', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/security-key', ], 'input' => [ 'shape' => 'AssociateSecurityKeyRequest', ], 'output' => [ 'shape' => 'AssociateSecurityKeyResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'AssociateTrafficDistributionGroupUser' => [ 'name' => 'AssociateTrafficDistributionGroupUser', 'http' => [ 'method' => 'PUT', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}/user', ], 'input' => [ 'shape' => 'AssociateTrafficDistributionGroupUserRequest', ], 'output' => [ 'shape' => 'AssociateTrafficDistributionGroupUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], ], 'idempotent' => true, ], 'AssociateUserProficiencies' => [ 'name' => 'AssociateUserProficiencies', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/associate-proficiencies', ], 'input' => [ 'shape' => 'AssociateUserProficienciesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'BatchAssociateAnalyticsDataSet' => [ 'name' => 'BatchAssociateAnalyticsDataSet', 'http' => [ 'method' => 'PUT', 'requestUri' => '/analytics-data/instance/{InstanceId}/associations', ], 'input' => [ 'shape' => 'BatchAssociateAnalyticsDataSetRequest', ], 'output' => [ 'shape' => 'BatchAssociateAnalyticsDataSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'BatchDisassociateAnalyticsDataSet' => [ 'name' => 'BatchDisassociateAnalyticsDataSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/analytics-data/instance/{InstanceId}/associations', ], 'input' => [ 'shape' => 'BatchDisassociateAnalyticsDataSetRequest', ], 'output' => [ 'shape' => 'BatchDisassociateAnalyticsDataSetResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'BatchGetAttachedFileMetadata' => [ 'name' => 'BatchGetAttachedFileMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/attached-files/{InstanceId}', ], 'input' => [ 'shape' => 'BatchGetAttachedFileMetadataRequest', ], 'output' => [ 'shape' => 'BatchGetAttachedFileMetadataResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'BatchGetFlowAssociation' => [ 'name' => 'BatchGetFlowAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/flow-associations-batch/{InstanceId}', ], 'input' => [ 'shape' => 'BatchGetFlowAssociationRequest', ], 'output' => [ 'shape' => 'BatchGetFlowAssociationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'BatchPutContact' => [ 'name' => 'BatchPutContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/batch/{InstanceId}', ], 'input' => [ 'shape' => 'BatchPutContactRequest', ], 'output' => [ 'shape' => 'BatchPutContactResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'IdempotencyException', ], ], 'idempotent' => true, ], 'ClaimPhoneNumber' => [ 'name' => 'ClaimPhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number/claim', ], 'input' => [ 'shape' => 'ClaimPhoneNumberRequest', ], 'output' => [ 'shape' => 'ClaimPhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CompleteAttachedFileUpload' => [ 'name' => 'CompleteAttachedFileUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/attached-files/{InstanceId}/{FileId}', ], 'input' => [ 'shape' => 'CompleteAttachedFileUploadRequest', ], 'output' => [ 'shape' => 'CompleteAttachedFileUploadResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateAgentStatus' => [ 'name' => 'CreateAgentStatus', 'http' => [ 'method' => 'PUT', 'requestUri' => '/agent-status/{InstanceId}', ], 'input' => [ 'shape' => 'CreateAgentStatusRequest', ], 'output' => [ 'shape' => 'CreateAgentStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateContactFlow' => [ 'name' => 'CreateContactFlow', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact-flows/{InstanceId}', ], 'input' => [ 'shape' => 'CreateContactFlowRequest', ], 'output' => [ 'shape' => 'CreateContactFlowResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidContactFlowException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateContactFlowModule' => [ 'name' => 'CreateContactFlowModule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact-flow-modules/{InstanceId}', ], 'input' => [ 'shape' => 'CreateContactFlowModuleRequest', ], 'output' => [ 'shape' => 'CreateContactFlowModuleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidContactFlowModuleException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateEvaluationForm' => [ 'name' => 'CreateEvaluationForm', 'http' => [ 'method' => 'PUT', 'requestUri' => '/evaluation-forms/{InstanceId}', ], 'input' => [ 'shape' => 'CreateEvaluationFormRequest', ], 'output' => [ 'shape' => 'CreateEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'CreateHoursOfOperation' => [ 'name' => 'CreateHoursOfOperation', 'http' => [ 'method' => 'PUT', 'requestUri' => '/hours-of-operations/{InstanceId}', ], 'input' => [ 'shape' => 'CreateHoursOfOperationRequest', ], 'output' => [ 'shape' => 'CreateHoursOfOperationResponse', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateInstance' => [ 'name' => 'CreateInstance', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance', ], 'input' => [ 'shape' => 'CreateInstanceRequest', ], 'output' => [ 'shape' => 'CreateInstanceResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateIntegrationAssociation' => [ 'name' => 'CreateIntegrationAssociation', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/integration-associations', ], 'input' => [ 'shape' => 'CreateIntegrationAssociationRequest', ], 'output' => [ 'shape' => 'CreateIntegrationAssociationResponse', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateParticipant' => [ 'name' => 'CreateParticipant', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/create-participant', ], 'input' => [ 'shape' => 'CreateParticipantRequest', ], 'output' => [ 'shape' => 'CreateParticipantResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreatePersistentContactAssociation' => [ 'name' => 'CreatePersistentContactAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/persistent-contact-association/{InstanceId}/{InitialContactId}', ], 'input' => [ 'shape' => 'CreatePersistentContactAssociationRequest', ], 'output' => [ 'shape' => 'CreatePersistentContactAssociationResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreatePredefinedAttribute' => [ 'name' => 'CreatePredefinedAttribute', 'http' => [ 'method' => 'PUT', 'requestUri' => '/predefined-attributes/{InstanceId}', ], 'input' => [ 'shape' => 'CreatePredefinedAttributeRequest', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreatePrompt' => [ 'name' => 'CreatePrompt', 'http' => [ 'method' => 'PUT', 'requestUri' => '/prompts/{InstanceId}', ], 'input' => [ 'shape' => 'CreatePromptRequest', ], 'output' => [ 'shape' => 'CreatePromptResponse', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateQueue' => [ 'name' => 'CreateQueue', 'http' => [ 'method' => 'PUT', 'requestUri' => '/queues/{InstanceId}', ], 'input' => [ 'shape' => 'CreateQueueRequest', ], 'output' => [ 'shape' => 'CreateQueueResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateQuickConnect' => [ 'name' => 'CreateQuickConnect', 'http' => [ 'method' => 'PUT', 'requestUri' => '/quick-connects/{InstanceId}', ], 'input' => [ 'shape' => 'CreateQuickConnectRequest', ], 'output' => [ 'shape' => 'CreateQuickConnectResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateRoutingProfile' => [ 'name' => 'CreateRoutingProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/routing-profiles/{InstanceId}', ], 'input' => [ 'shape' => 'CreateRoutingProfileRequest', ], 'output' => [ 'shape' => 'CreateRoutingProfileResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateRule' => [ 'name' => 'CreateRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/rules/{InstanceId}', ], 'input' => [ 'shape' => 'CreateRuleRequest', ], 'output' => [ 'shape' => 'CreateRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'CreateSecurityProfile' => [ 'name' => 'CreateSecurityProfile', 'http' => [ 'method' => 'PUT', 'requestUri' => '/security-profiles/{InstanceId}', ], 'input' => [ 'shape' => 'CreateSecurityProfileRequest', ], 'output' => [ 'shape' => 'CreateSecurityProfileResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateTaskTemplate' => [ 'name' => 'CreateTaskTemplate', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/task/template', ], 'input' => [ 'shape' => 'CreateTaskTemplateRequest', ], 'output' => [ 'shape' => 'CreateTaskTemplateResponse', ], 'errors' => [ [ 'shape' => 'PropertyValidationException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateTrafficDistributionGroup' => [ 'name' => 'CreateTrafficDistributionGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/traffic-distribution-group', ], 'input' => [ 'shape' => 'CreateTrafficDistributionGroupRequest', ], 'output' => [ 'shape' => 'CreateTrafficDistributionGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ResourceNotReadyException', ], ], ], 'CreateUseCase' => [ 'name' => 'CreateUseCase', 'http' => [ 'method' => 'PUT', 'requestUri' => '/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases', ], 'input' => [ 'shape' => 'CreateUseCaseRequest', ], 'output' => [ 'shape' => 'CreateUseCaseResponse', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'CreateUser' => [ 'name' => 'CreateUser', 'http' => [ 'method' => 'PUT', 'requestUri' => '/users/{InstanceId}', ], 'input' => [ 'shape' => 'CreateUserRequest', ], 'output' => [ 'shape' => 'CreateUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateUserHierarchyGroup' => [ 'name' => 'CreateUserHierarchyGroup', 'http' => [ 'method' => 'PUT', 'requestUri' => '/user-hierarchy-groups/{InstanceId}', ], 'input' => [ 'shape' => 'CreateUserHierarchyGroupRequest', ], 'output' => [ 'shape' => 'CreateUserHierarchyGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'CreateView' => [ 'name' => 'CreateView', 'http' => [ 'method' => 'PUT', 'requestUri' => '/views/{InstanceId}', ], 'input' => [ 'shape' => 'CreateViewRequest', ], 'output' => [ 'shape' => 'CreateViewResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'CreateViewVersion' => [ 'name' => 'CreateViewVersion', 'http' => [ 'method' => 'PUT', 'requestUri' => '/views/{InstanceId}/{ViewId}/versions', ], 'input' => [ 'shape' => 'CreateViewVersionRequest', ], 'output' => [ 'shape' => 'CreateViewVersionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceInUseException', ], ], 'idempotent' => true, ], 'CreateVocabulary' => [ 'name' => 'CreateVocabulary', 'http' => [ 'method' => 'POST', 'requestUri' => '/vocabulary/{InstanceId}', ], 'input' => [ 'shape' => 'CreateVocabularyRequest', ], 'output' => [ 'shape' => 'CreateVocabularyResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'DeactivateEvaluationForm' => [ 'name' => 'DeactivateEvaluationForm', 'http' => [ 'method' => 'POST', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}/deactivate', ], 'input' => [ 'shape' => 'DeactivateEvaluationFormRequest', ], 'output' => [ 'shape' => 'DeactivateEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'DeleteAttachedFile' => [ 'name' => 'DeleteAttachedFile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/attached-files/{InstanceId}/{FileId}', ], 'input' => [ 'shape' => 'DeleteAttachedFileRequest', ], 'output' => [ 'shape' => 'DeleteAttachedFileResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteContactEvaluation' => [ 'name' => 'DeleteContactEvaluation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/contact-evaluations/{InstanceId}/{EvaluationId}', ], 'input' => [ 'shape' => 'DeleteContactEvaluationRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'DeleteContactFlow' => [ 'name' => 'DeleteContactFlow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}', ], 'input' => [ 'shape' => 'DeleteContactFlowRequest', ], 'output' => [ 'shape' => 'DeleteContactFlowResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteContactFlowModule' => [ 'name' => 'DeleteContactFlowModule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}', ], 'input' => [ 'shape' => 'DeleteContactFlowModuleRequest', ], 'output' => [ 'shape' => 'DeleteContactFlowModuleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteEvaluationForm' => [ 'name' => 'DeleteEvaluationForm', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}', ], 'input' => [ 'shape' => 'DeleteEvaluationFormRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'DeleteHoursOfOperation' => [ 'name' => 'DeleteHoursOfOperation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/hours-of-operations/{InstanceId}/{HoursOfOperationId}', ], 'input' => [ 'shape' => 'DeleteHoursOfOperationRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteInstance' => [ 'name' => 'DeleteInstance', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}', ], 'input' => [ 'shape' => 'DeleteInstanceRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteIntegrationAssociation' => [ 'name' => 'DeleteIntegrationAssociation', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}', ], 'input' => [ 'shape' => 'DeleteIntegrationAssociationRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeletePredefinedAttribute' => [ 'name' => 'DeletePredefinedAttribute', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/predefined-attributes/{InstanceId}/{Name}', ], 'input' => [ 'shape' => 'DeletePredefinedAttributeRequest', ], 'errors' => [ [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], 'idempotent' => true, ], 'DeletePrompt' => [ 'name' => 'DeletePrompt', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/prompts/{InstanceId}/{PromptId}', ], 'input' => [ 'shape' => 'DeletePromptRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteQueue' => [ 'name' => 'DeleteQueue', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/queues/{InstanceId}/{QueueId}', ], 'input' => [ 'shape' => 'DeleteQueueRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteQuickConnect' => [ 'name' => 'DeleteQuickConnect', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/quick-connects/{InstanceId}/{QuickConnectId}', ], 'input' => [ 'shape' => 'DeleteQuickConnectRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteRoutingProfile' => [ 'name' => 'DeleteRoutingProfile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}', ], 'input' => [ 'shape' => 'DeleteRoutingProfileRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteRule' => [ 'name' => 'DeleteRule', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/rules/{InstanceId}/{RuleId}', ], 'input' => [ 'shape' => 'DeleteRuleRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DeleteSecurityProfile' => [ 'name' => 'DeleteSecurityProfile', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/security-profiles/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'DeleteSecurityProfileRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteTaskTemplate' => [ 'name' => 'DeleteTaskTemplate', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/task/template/{TaskTemplateId}', ], 'input' => [ 'shape' => 'DeleteTaskTemplateRequest', ], 'output' => [ 'shape' => 'DeleteTaskTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteTrafficDistributionGroup' => [ 'name' => 'DeleteTrafficDistributionGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}', ], 'input' => [ 'shape' => 'DeleteTrafficDistributionGroupRequest', ], 'output' => [ 'shape' => 'DeleteTrafficDistributionGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteUseCase' => [ 'name' => 'DeleteUseCase', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}', ], 'input' => [ 'shape' => 'DeleteUseCaseRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/users/{InstanceId}/{UserId}', ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteUserHierarchyGroup' => [ 'name' => 'DeleteUserHierarchyGroup', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}', ], 'input' => [ 'shape' => 'DeleteUserHierarchyGroupRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DeleteView' => [ 'name' => 'DeleteView', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/views/{InstanceId}/{ViewId}', ], 'input' => [ 'shape' => 'DeleteViewRequest', ], 'output' => [ 'shape' => 'DeleteViewResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteViewVersion' => [ 'name' => 'DeleteViewVersion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/views/{InstanceId}/{ViewId}/versions/{ViewVersion}', ], 'input' => [ 'shape' => 'DeleteViewVersionRequest', ], 'output' => [ 'shape' => 'DeleteViewVersionResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DeleteVocabulary' => [ 'name' => 'DeleteVocabulary', 'http' => [ 'method' => 'POST', 'requestUri' => '/vocabulary-remove/{InstanceId}/{VocabularyId}', ], 'input' => [ 'shape' => 'DeleteVocabularyRequest', ], 'output' => [ 'shape' => 'DeleteVocabularyResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'DescribeAgentStatus' => [ 'name' => 'DescribeAgentStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/agent-status/{InstanceId}/{AgentStatusId}', ], 'input' => [ 'shape' => 'DescribeAgentStatusRequest', ], 'output' => [ 'shape' => 'DescribeAgentStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeContact' => [ 'name' => 'DescribeContact', 'http' => [ 'method' => 'GET', 'requestUri' => '/contacts/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'DescribeContactRequest', ], 'output' => [ 'shape' => 'DescribeContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DescribeContactEvaluation' => [ 'name' => 'DescribeContactEvaluation', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-evaluations/{InstanceId}/{EvaluationId}', ], 'input' => [ 'shape' => 'DescribeContactEvaluationRequest', ], 'output' => [ 'shape' => 'DescribeContactEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeContactFlow' => [ 'name' => 'DescribeContactFlow', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}', ], 'input' => [ 'shape' => 'DescribeContactFlowRequest', ], 'output' => [ 'shape' => 'DescribeContactFlowResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ContactFlowNotPublishedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeContactFlowModule' => [ 'name' => 'DescribeContactFlowModule', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}', ], 'input' => [ 'shape' => 'DescribeContactFlowModuleRequest', ], 'output' => [ 'shape' => 'DescribeContactFlowModuleResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeEvaluationForm' => [ 'name' => 'DescribeEvaluationForm', 'http' => [ 'method' => 'GET', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}', ], 'input' => [ 'shape' => 'DescribeEvaluationFormRequest', ], 'output' => [ 'shape' => 'DescribeEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeHoursOfOperation' => [ 'name' => 'DescribeHoursOfOperation', 'http' => [ 'method' => 'GET', 'requestUri' => '/hours-of-operations/{InstanceId}/{HoursOfOperationId}', ], 'input' => [ 'shape' => 'DescribeHoursOfOperationRequest', ], 'output' => [ 'shape' => 'DescribeHoursOfOperationResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeInstance' => [ 'name' => 'DescribeInstance', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}', ], 'input' => [ 'shape' => 'DescribeInstanceRequest', ], 'output' => [ 'shape' => 'DescribeInstanceResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeInstanceAttribute' => [ 'name' => 'DescribeInstanceAttribute', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/attribute/{AttributeType}', ], 'input' => [ 'shape' => 'DescribeInstanceAttributeRequest', ], 'output' => [ 'shape' => 'DescribeInstanceAttributeResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DescribeInstanceStorageConfig' => [ 'name' => 'DescribeInstanceStorageConfig', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/storage-config/{AssociationId}', ], 'input' => [ 'shape' => 'DescribeInstanceStorageConfigRequest', ], 'output' => [ 'shape' => 'DescribeInstanceStorageConfigResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DescribePhoneNumber' => [ 'name' => 'DescribePhoneNumber', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-number/{PhoneNumberId}', ], 'input' => [ 'shape' => 'DescribePhoneNumberRequest', ], 'output' => [ 'shape' => 'DescribePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribePredefinedAttribute' => [ 'name' => 'DescribePredefinedAttribute', 'http' => [ 'method' => 'GET', 'requestUri' => '/predefined-attributes/{InstanceId}/{Name}', ], 'input' => [ 'shape' => 'DescribePredefinedAttributeRequest', ], 'output' => [ 'shape' => 'DescribePredefinedAttributeResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribePrompt' => [ 'name' => 'DescribePrompt', 'http' => [ 'method' => 'GET', 'requestUri' => '/prompts/{InstanceId}/{PromptId}', ], 'input' => [ 'shape' => 'DescribePromptRequest', ], 'output' => [ 'shape' => 'DescribePromptResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeQueue' => [ 'name' => 'DescribeQueue', 'http' => [ 'method' => 'GET', 'requestUri' => '/queues/{InstanceId}/{QueueId}', ], 'input' => [ 'shape' => 'DescribeQueueRequest', ], 'output' => [ 'shape' => 'DescribeQueueResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeQuickConnect' => [ 'name' => 'DescribeQuickConnect', 'http' => [ 'method' => 'GET', 'requestUri' => '/quick-connects/{InstanceId}/{QuickConnectId}', ], 'input' => [ 'shape' => 'DescribeQuickConnectRequest', ], 'output' => [ 'shape' => 'DescribeQuickConnectResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeRoutingProfile' => [ 'name' => 'DescribeRoutingProfile', 'http' => [ 'method' => 'GET', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}', ], 'input' => [ 'shape' => 'DescribeRoutingProfileRequest', ], 'output' => [ 'shape' => 'DescribeRoutingProfileResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeRule' => [ 'name' => 'DescribeRule', 'http' => [ 'method' => 'GET', 'requestUri' => '/rules/{InstanceId}/{RuleId}', ], 'input' => [ 'shape' => 'DescribeRuleRequest', ], 'output' => [ 'shape' => 'DescribeRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DescribeSecurityProfile' => [ 'name' => 'DescribeSecurityProfile', 'http' => [ 'method' => 'GET', 'requestUri' => '/security-profiles/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'DescribeSecurityProfileRequest', ], 'output' => [ 'shape' => 'DescribeSecurityProfileResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeTrafficDistributionGroup' => [ 'name' => 'DescribeTrafficDistributionGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}', ], 'input' => [ 'shape' => 'DescribeTrafficDistributionGroupRequest', ], 'output' => [ 'shape' => 'DescribeTrafficDistributionGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DescribeUser' => [ 'name' => 'DescribeUser', 'http' => [ 'method' => 'GET', 'requestUri' => '/users/{InstanceId}/{UserId}', ], 'input' => [ 'shape' => 'DescribeUserRequest', ], 'output' => [ 'shape' => 'DescribeUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeUserHierarchyGroup' => [ 'name' => 'DescribeUserHierarchyGroup', 'http' => [ 'method' => 'GET', 'requestUri' => '/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}', ], 'input' => [ 'shape' => 'DescribeUserHierarchyGroupRequest', ], 'output' => [ 'shape' => 'DescribeUserHierarchyGroupResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeUserHierarchyStructure' => [ 'name' => 'DescribeUserHierarchyStructure', 'http' => [ 'method' => 'GET', 'requestUri' => '/user-hierarchy-structure/{InstanceId}', ], 'input' => [ 'shape' => 'DescribeUserHierarchyStructureRequest', ], 'output' => [ 'shape' => 'DescribeUserHierarchyStructureResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DescribeView' => [ 'name' => 'DescribeView', 'http' => [ 'method' => 'GET', 'requestUri' => '/views/{InstanceId}/{ViewId}', ], 'input' => [ 'shape' => 'DescribeViewRequest', ], 'output' => [ 'shape' => 'DescribeViewResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'DescribeVocabulary' => [ 'name' => 'DescribeVocabulary', 'http' => [ 'method' => 'GET', 'requestUri' => '/vocabulary/{InstanceId}/{VocabularyId}', ], 'input' => [ 'shape' => 'DescribeVocabularyRequest', ], 'output' => [ 'shape' => 'DescribeVocabularyResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DisassociateAnalyticsDataSet' => [ 'name' => 'DisassociateAnalyticsDataSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/analytics-data/instance/{InstanceId}/association', ], 'input' => [ 'shape' => 'DisassociateAnalyticsDataSetRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DisassociateApprovedOrigin' => [ 'name' => 'DisassociateApprovedOrigin', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/approved-origin', ], 'input' => [ 'shape' => 'DisassociateApprovedOriginRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateBot' => [ 'name' => 'DisassociateBot', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/bot', ], 'input' => [ 'shape' => 'DisassociateBotRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateFlow' => [ 'name' => 'DisassociateFlow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}', ], 'input' => [ 'shape' => 'DisassociateFlowRequest', ], 'output' => [ 'shape' => 'DisassociateFlowResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateInstanceStorageConfig' => [ 'name' => 'DisassociateInstanceStorageConfig', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/storage-config/{AssociationId}', ], 'input' => [ 'shape' => 'DisassociateInstanceStorageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateLambdaFunction' => [ 'name' => 'DisassociateLambdaFunction', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/lambda-function', ], 'input' => [ 'shape' => 'DisassociateLambdaFunctionRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateLexBot' => [ 'name' => 'DisassociateLexBot', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/lex-bot', ], 'input' => [ 'shape' => 'DisassociateLexBotRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociatePhoneNumberContactFlow' => [ 'name' => 'DisassociatePhoneNumberContactFlow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/phone-number/{PhoneNumberId}/contact-flow', ], 'input' => [ 'shape' => 'DisassociatePhoneNumberContactFlowRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'DisassociateQueueQuickConnects' => [ 'name' => 'DisassociateQueueQuickConnects', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/disassociate-quick-connects', ], 'input' => [ 'shape' => 'DisassociateQueueQuickConnectsRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DisassociateRoutingProfileQueues' => [ 'name' => 'DisassociateRoutingProfileQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues', ], 'input' => [ 'shape' => 'DisassociateRoutingProfileQueuesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DisassociateSecurityKey' => [ 'name' => 'DisassociateSecurityKey', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/instance/{InstanceId}/security-key/{AssociationId}', ], 'input' => [ 'shape' => 'DisassociateSecurityKeyRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'DisassociateTrafficDistributionGroupUser' => [ 'name' => 'DisassociateTrafficDistributionGroupUser', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}/user', ], 'input' => [ 'shape' => 'DisassociateTrafficDistributionGroupUserRequest', ], 'output' => [ 'shape' => 'DisassociateTrafficDistributionGroupUserResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InternalServiceException', ], ], 'idempotent' => true, ], 'DisassociateUserProficiencies' => [ 'name' => 'DisassociateUserProficiencies', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/disassociate-proficiencies', ], 'input' => [ 'shape' => 'DisassociateUserProficienciesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'DismissUserContact' => [ 'name' => 'DismissUserContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/contact', ], 'input' => [ 'shape' => 'DismissUserContactRequest', ], 'output' => [ 'shape' => 'DismissUserContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetAttachedFile' => [ 'name' => 'GetAttachedFile', 'http' => [ 'method' => 'GET', 'requestUri' => '/attached-files/{InstanceId}/{FileId}', ], 'input' => [ 'shape' => 'GetAttachedFileRequest', ], 'output' => [ 'shape' => 'GetAttachedFileResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetContactAttributes' => [ 'name' => 'GetContactAttributes', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact/attributes/{InstanceId}/{InitialContactId}', ], 'input' => [ 'shape' => 'GetContactAttributesRequest', ], 'output' => [ 'shape' => 'GetContactAttributesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetCurrentMetricData' => [ 'name' => 'GetCurrentMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/metrics/current/{InstanceId}', ], 'input' => [ 'shape' => 'GetCurrentMetricDataRequest', ], 'output' => [ 'shape' => 'GetCurrentMetricDataResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetCurrentUserData' => [ 'name' => 'GetCurrentUserData', 'http' => [ 'method' => 'POST', 'requestUri' => '/metrics/userdata/{InstanceId}', ], 'input' => [ 'shape' => 'GetCurrentUserDataRequest', ], 'output' => [ 'shape' => 'GetCurrentUserDataResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetFederationToken' => [ 'name' => 'GetFederationToken', 'http' => [ 'method' => 'GET', 'requestUri' => '/user/federate/{InstanceId}', ], 'input' => [ 'shape' => 'GetFederationTokenRequest', ], 'output' => [ 'shape' => 'GetFederationTokenResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UserNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'DuplicateResourceException', ], ], ], 'GetFlowAssociation' => [ 'name' => 'GetFlowAssociation', 'http' => [ 'method' => 'GET', 'requestUri' => '/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}', ], 'input' => [ 'shape' => 'GetFlowAssociationRequest', ], 'output' => [ 'shape' => 'GetFlowAssociationResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'GetMetricData' => [ 'name' => 'GetMetricData', 'http' => [ 'method' => 'POST', 'requestUri' => '/metrics/historical/{InstanceId}', ], 'input' => [ 'shape' => 'GetMetricDataRequest', ], 'output' => [ 'shape' => 'GetMetricDataResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetMetricDataV2' => [ 'name' => 'GetMetricDataV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/metrics/data', ], 'input' => [ 'shape' => 'GetMetricDataV2Request', ], 'output' => [ 'shape' => 'GetMetricDataV2Response', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetPromptFile' => [ 'name' => 'GetPromptFile', 'http' => [ 'method' => 'GET', 'requestUri' => '/prompts/{InstanceId}/{PromptId}/file', ], 'input' => [ 'shape' => 'GetPromptFileRequest', ], 'output' => [ 'shape' => 'GetPromptFileResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetTaskTemplate' => [ 'name' => 'GetTaskTemplate', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/task/template/{TaskTemplateId}', ], 'input' => [ 'shape' => 'GetTaskTemplateRequest', ], 'output' => [ 'shape' => 'GetTaskTemplateResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'GetTrafficDistribution' => [ 'name' => 'GetTrafficDistribution', 'http' => [ 'method' => 'GET', 'requestUri' => '/traffic-distribution/{Id}', ], 'input' => [ 'shape' => 'GetTrafficDistributionRequest', ], 'output' => [ 'shape' => 'GetTrafficDistributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ImportPhoneNumber' => [ 'name' => 'ImportPhoneNumber', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number/import', ], 'input' => [ 'shape' => 'ImportPhoneNumberRequest', ], 'output' => [ 'shape' => 'ImportPhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListAgentStatuses' => [ 'name' => 'ListAgentStatuses', 'http' => [ 'method' => 'GET', 'requestUri' => '/agent-status/{InstanceId}', ], 'input' => [ 'shape' => 'ListAgentStatusRequest', ], 'output' => [ 'shape' => 'ListAgentStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListAnalyticsDataAssociations' => [ 'name' => 'ListAnalyticsDataAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/analytics-data/instance/{InstanceId}/association', ], 'input' => [ 'shape' => 'ListAnalyticsDataAssociationsRequest', ], 'output' => [ 'shape' => 'ListAnalyticsDataAssociationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListApprovedOrigins' => [ 'name' => 'ListApprovedOrigins', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/approved-origins', ], 'input' => [ 'shape' => 'ListApprovedOriginsRequest', ], 'output' => [ 'shape' => 'ListApprovedOriginsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListBots' => [ 'name' => 'ListBots', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/bots', ], 'input' => [ 'shape' => 'ListBotsRequest', ], 'output' => [ 'shape' => 'ListBotsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListContactEvaluations' => [ 'name' => 'ListContactEvaluations', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-evaluations/{InstanceId}', ], 'input' => [ 'shape' => 'ListContactEvaluationsRequest', ], 'output' => [ 'shape' => 'ListContactEvaluationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListContactFlowModules' => [ 'name' => 'ListContactFlowModules', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-flow-modules-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListContactFlowModulesRequest', ], 'output' => [ 'shape' => 'ListContactFlowModulesResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListContactFlows' => [ 'name' => 'ListContactFlows', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact-flows-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListContactFlowsRequest', ], 'output' => [ 'shape' => 'ListContactFlowsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListContactReferences' => [ 'name' => 'ListContactReferences', 'http' => [ 'method' => 'GET', 'requestUri' => '/contact/references/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'ListContactReferencesRequest', ], 'output' => [ 'shape' => 'ListContactReferencesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListDefaultVocabularies' => [ 'name' => 'ListDefaultVocabularies', 'http' => [ 'method' => 'POST', 'requestUri' => '/default-vocabulary-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListDefaultVocabulariesRequest', ], 'output' => [ 'shape' => 'ListDefaultVocabulariesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListEvaluationFormVersions' => [ 'name' => 'ListEvaluationFormVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}/versions', ], 'input' => [ 'shape' => 'ListEvaluationFormVersionsRequest', ], 'output' => [ 'shape' => 'ListEvaluationFormVersionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListEvaluationForms' => [ 'name' => 'ListEvaluationForms', 'http' => [ 'method' => 'GET', 'requestUri' => '/evaluation-forms/{InstanceId}', ], 'input' => [ 'shape' => 'ListEvaluationFormsRequest', ], 'output' => [ 'shape' => 'ListEvaluationFormsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListFlowAssociations' => [ 'name' => 'ListFlowAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/flow-associations-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListFlowAssociationsRequest', ], 'output' => [ 'shape' => 'ListFlowAssociationsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListHoursOfOperations' => [ 'name' => 'ListHoursOfOperations', 'http' => [ 'method' => 'GET', 'requestUri' => '/hours-of-operations-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListHoursOfOperationsRequest', ], 'output' => [ 'shape' => 'ListHoursOfOperationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListInstanceAttributes' => [ 'name' => 'ListInstanceAttributes', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/attributes', ], 'input' => [ 'shape' => 'ListInstanceAttributesRequest', ], 'output' => [ 'shape' => 'ListInstanceAttributesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListInstanceStorageConfigs' => [ 'name' => 'ListInstanceStorageConfigs', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/storage-configs', ], 'input' => [ 'shape' => 'ListInstanceStorageConfigsRequest', ], 'output' => [ 'shape' => 'ListInstanceStorageConfigsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListInstances' => [ 'name' => 'ListInstances', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance', ], 'input' => [ 'shape' => 'ListInstancesRequest', ], 'output' => [ 'shape' => 'ListInstancesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListIntegrationAssociations' => [ 'name' => 'ListIntegrationAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/integration-associations', ], 'input' => [ 'shape' => 'ListIntegrationAssociationsRequest', ], 'output' => [ 'shape' => 'ListIntegrationAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListLambdaFunctions' => [ 'name' => 'ListLambdaFunctions', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/lambda-functions', ], 'input' => [ 'shape' => 'ListLambdaFunctionsRequest', ], 'output' => [ 'shape' => 'ListLambdaFunctionsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListLexBots' => [ 'name' => 'ListLexBots', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/lex-bots', ], 'input' => [ 'shape' => 'ListLexBotsRequest', ], 'output' => [ 'shape' => 'ListLexBotsResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListPhoneNumbers' => [ 'name' => 'ListPhoneNumbers', 'http' => [ 'method' => 'GET', 'requestUri' => '/phone-numbers-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListPhoneNumbersRequest', ], 'output' => [ 'shape' => 'ListPhoneNumbersResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListPhoneNumbersV2' => [ 'name' => 'ListPhoneNumbersV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number/list', ], 'input' => [ 'shape' => 'ListPhoneNumbersV2Request', ], 'output' => [ 'shape' => 'ListPhoneNumbersV2Response', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListPredefinedAttributes' => [ 'name' => 'ListPredefinedAttributes', 'http' => [ 'method' => 'GET', 'requestUri' => '/predefined-attributes/{InstanceId}', ], 'input' => [ 'shape' => 'ListPredefinedAttributesRequest', ], 'output' => [ 'shape' => 'ListPredefinedAttributesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListPrompts' => [ 'name' => 'ListPrompts', 'http' => [ 'method' => 'GET', 'requestUri' => '/prompts-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListPromptsRequest', ], 'output' => [ 'shape' => 'ListPromptsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListQueueQuickConnects' => [ 'name' => 'ListQueueQuickConnects', 'http' => [ 'method' => 'GET', 'requestUri' => '/queues/{InstanceId}/{QueueId}/quick-connects', ], 'input' => [ 'shape' => 'ListQueueQuickConnectsRequest', ], 'output' => [ 'shape' => 'ListQueueQuickConnectsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListQueues' => [ 'name' => 'ListQueues', 'http' => [ 'method' => 'GET', 'requestUri' => '/queues-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListQueuesRequest', ], 'output' => [ 'shape' => 'ListQueuesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListQuickConnects' => [ 'name' => 'ListQuickConnects', 'http' => [ 'method' => 'GET', 'requestUri' => '/quick-connects/{InstanceId}', ], 'input' => [ 'shape' => 'ListQuickConnectsRequest', ], 'output' => [ 'shape' => 'ListQuickConnectsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListRealtimeContactAnalysisSegmentsV2' => [ 'name' => 'ListRealtimeContactAnalysisSegmentsV2', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'ListRealtimeContactAnalysisSegmentsV2Request', ], 'output' => [ 'shape' => 'ListRealtimeContactAnalysisSegmentsV2Response', ], 'errors' => [ [ 'shape' => 'OutputTypeNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListRoutingProfileQueues' => [ 'name' => 'ListRoutingProfileQueues', 'http' => [ 'method' => 'GET', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/queues', ], 'input' => [ 'shape' => 'ListRoutingProfileQueuesRequest', ], 'output' => [ 'shape' => 'ListRoutingProfileQueuesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListRoutingProfiles' => [ 'name' => 'ListRoutingProfiles', 'http' => [ 'method' => 'GET', 'requestUri' => '/routing-profiles-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListRoutingProfilesRequest', ], 'output' => [ 'shape' => 'ListRoutingProfilesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListRules' => [ 'name' => 'ListRules', 'http' => [ 'method' => 'GET', 'requestUri' => '/rules/{InstanceId}', ], 'input' => [ 'shape' => 'ListRulesRequest', ], 'output' => [ 'shape' => 'ListRulesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListSecurityKeys' => [ 'name' => 'ListSecurityKeys', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/security-keys', ], 'input' => [ 'shape' => 'ListSecurityKeysRequest', ], 'output' => [ 'shape' => 'ListSecurityKeysResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListSecurityProfileApplications' => [ 'name' => 'ListSecurityProfileApplications', 'http' => [ 'method' => 'GET', 'requestUri' => '/security-profiles-applications/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'ListSecurityProfileApplicationsRequest', ], 'output' => [ 'shape' => 'ListSecurityProfileApplicationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListSecurityProfilePermissions' => [ 'name' => 'ListSecurityProfilePermissions', 'http' => [ 'method' => 'GET', 'requestUri' => '/security-profiles-permissions/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'ListSecurityProfilePermissionsRequest', ], 'output' => [ 'shape' => 'ListSecurityProfilePermissionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListSecurityProfiles' => [ 'name' => 'ListSecurityProfiles', 'http' => [ 'method' => 'GET', 'requestUri' => '/security-profiles-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListSecurityProfilesRequest', ], 'output' => [ 'shape' => 'ListSecurityProfilesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListTaskTemplates' => [ 'name' => 'ListTaskTemplates', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/task/template', ], 'input' => [ 'shape' => 'ListTaskTemplatesRequest', ], 'output' => [ 'shape' => 'ListTaskTemplatesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListTrafficDistributionGroupUsers' => [ 'name' => 'ListTrafficDistributionGroupUsers', 'http' => [ 'method' => 'GET', 'requestUri' => '/traffic-distribution-group/{TrafficDistributionGroupId}/user', ], 'input' => [ 'shape' => 'ListTrafficDistributionGroupUsersRequest', ], 'output' => [ 'shape' => 'ListTrafficDistributionGroupUsersResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListTrafficDistributionGroups' => [ 'name' => 'ListTrafficDistributionGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/traffic-distribution-groups', ], 'input' => [ 'shape' => 'ListTrafficDistributionGroupsRequest', ], 'output' => [ 'shape' => 'ListTrafficDistributionGroupsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListUseCases' => [ 'name' => 'ListUseCases', 'http' => [ 'method' => 'GET', 'requestUri' => '/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases', ], 'input' => [ 'shape' => 'ListUseCasesRequest', ], 'output' => [ 'shape' => 'ListUseCasesResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'ListUserHierarchyGroups' => [ 'name' => 'ListUserHierarchyGroups', 'http' => [ 'method' => 'GET', 'requestUri' => '/user-hierarchy-groups-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListUserHierarchyGroupsRequest', ], 'output' => [ 'shape' => 'ListUserHierarchyGroupsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListUserProficiencies' => [ 'name' => 'ListUserProficiencies', 'http' => [ 'method' => 'GET', 'requestUri' => '/users/{InstanceId}/{UserId}/proficiencies', ], 'input' => [ 'shape' => 'ListUserProficienciesRequest', ], 'output' => [ 'shape' => 'ListUserProficienciesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListUsers' => [ 'name' => 'ListUsers', 'http' => [ 'method' => 'GET', 'requestUri' => '/users-summary/{InstanceId}', ], 'input' => [ 'shape' => 'ListUsersRequest', ], 'output' => [ 'shape' => 'ListUsersResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ListViewVersions' => [ 'name' => 'ListViewVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/views/{InstanceId}/{ViewId}/versions', ], 'input' => [ 'shape' => 'ListViewVersionsRequest', ], 'output' => [ 'shape' => 'ListViewVersionsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'ListViews' => [ 'name' => 'ListViews', 'http' => [ 'method' => 'GET', 'requestUri' => '/views/{InstanceId}', ], 'input' => [ 'shape' => 'ListViewsRequest', ], 'output' => [ 'shape' => 'ListViewsResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], ], ], 'MonitorContact' => [ 'name' => 'MonitorContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/monitor', ], 'input' => [ 'shape' => 'MonitorContactRequest', ], 'output' => [ 'shape' => 'MonitorContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'PauseContact' => [ 'name' => 'PauseContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/pause', ], 'input' => [ 'shape' => 'PauseContactRequest', ], 'output' => [ 'shape' => 'PauseContactResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ConflictException', ], ], ], 'PutUserStatus' => [ 'name' => 'PutUserStatus', 'http' => [ 'method' => 'PUT', 'requestUri' => '/users/{InstanceId}/{UserId}/status', ], 'input' => [ 'shape' => 'PutUserStatusRequest', ], 'output' => [ 'shape' => 'PutUserStatusResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'ReleasePhoneNumber' => [ 'name' => 'ReleasePhoneNumber', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/phone-number/{PhoneNumberId}', ], 'input' => [ 'shape' => 'ReleasePhoneNumberRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ReplicateInstance' => [ 'name' => 'ReplicateInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/replicate', ], 'input' => [ 'shape' => 'ReplicateInstanceRequest', ], 'output' => [ 'shape' => 'ReplicateInstanceResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotReadyException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'ResumeContact' => [ 'name' => 'ResumeContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/resume', ], 'input' => [ 'shape' => 'ResumeContactRequest', ], 'output' => [ 'shape' => 'ResumeContactResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ConflictException', ], ], ], 'ResumeContactRecording' => [ 'name' => 'ResumeContactRecording', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/resume-recording', ], 'input' => [ 'shape' => 'ResumeContactRecordingRequest', ], 'output' => [ 'shape' => 'ResumeContactRecordingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchAvailablePhoneNumbers' => [ 'name' => 'SearchAvailablePhoneNumbers', 'http' => [ 'method' => 'POST', 'requestUri' => '/phone-number/search-available', ], 'input' => [ 'shape' => 'SearchAvailablePhoneNumbersRequest', ], 'output' => [ 'shape' => 'SearchAvailablePhoneNumbersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'SearchContactFlowModules' => [ 'name' => 'SearchContactFlowModules', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-contact-flow-modules', ], 'input' => [ 'shape' => 'SearchContactFlowModulesRequest', ], 'output' => [ 'shape' => 'SearchContactFlowModulesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchContactFlows' => [ 'name' => 'SearchContactFlows', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-contact-flows', ], 'input' => [ 'shape' => 'SearchContactFlowsRequest', ], 'output' => [ 'shape' => 'SearchContactFlowsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchContacts' => [ 'name' => 'SearchContacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-contacts', ], 'input' => [ 'shape' => 'SearchContactsRequest', ], 'output' => [ 'shape' => 'SearchContactsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'SearchHoursOfOperations' => [ 'name' => 'SearchHoursOfOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-hours-of-operations', ], 'input' => [ 'shape' => 'SearchHoursOfOperationsRequest', ], 'output' => [ 'shape' => 'SearchHoursOfOperationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchPredefinedAttributes' => [ 'name' => 'SearchPredefinedAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-predefined-attributes', ], 'input' => [ 'shape' => 'SearchPredefinedAttributesRequest', ], 'output' => [ 'shape' => 'SearchPredefinedAttributesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchPrompts' => [ 'name' => 'SearchPrompts', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-prompts', ], 'input' => [ 'shape' => 'SearchPromptsRequest', ], 'output' => [ 'shape' => 'SearchPromptsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchQueues' => [ 'name' => 'SearchQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-queues', ], 'input' => [ 'shape' => 'SearchQueuesRequest', ], 'output' => [ 'shape' => 'SearchQueuesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchQuickConnects' => [ 'name' => 'SearchQuickConnects', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-quick-connects', ], 'input' => [ 'shape' => 'SearchQuickConnectsRequest', ], 'output' => [ 'shape' => 'SearchQuickConnectsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchResourceTags' => [ 'name' => 'SearchResourceTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-resource-tags', ], 'input' => [ 'shape' => 'SearchResourceTagsRequest', ], 'output' => [ 'shape' => 'SearchResourceTagsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'MaximumResultReturnedException', ], ], ], 'SearchRoutingProfiles' => [ 'name' => 'SearchRoutingProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-routing-profiles', ], 'input' => [ 'shape' => 'SearchRoutingProfilesRequest', ], 'output' => [ 'shape' => 'SearchRoutingProfilesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchSecurityProfiles' => [ 'name' => 'SearchSecurityProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-security-profiles', ], 'input' => [ 'shape' => 'SearchSecurityProfilesRequest', ], 'output' => [ 'shape' => 'SearchSecurityProfilesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchUsers' => [ 'name' => 'SearchUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/search-users', ], 'input' => [ 'shape' => 'SearchUsersRequest', ], 'output' => [ 'shape' => 'SearchUsersResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SearchVocabularies' => [ 'name' => 'SearchVocabularies', 'http' => [ 'method' => 'POST', 'requestUri' => '/vocabulary-summary/{InstanceId}', ], 'input' => [ 'shape' => 'SearchVocabulariesRequest', ], 'output' => [ 'shape' => 'SearchVocabulariesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'SendChatIntegrationEvent' => [ 'name' => 'SendChatIntegrationEvent', 'http' => [ 'method' => 'POST', 'requestUri' => '/chat-integration-event', ], 'input' => [ 'shape' => 'SendChatIntegrationEventRequest', ], 'output' => [ 'shape' => 'SendChatIntegrationEventResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'StartAttachedFileUpload' => [ 'name' => 'StartAttachedFileUpload', 'http' => [ 'method' => 'PUT', 'requestUri' => '/attached-files/{InstanceId}', ], 'input' => [ 'shape' => 'StartAttachedFileUploadRequest', ], 'output' => [ 'shape' => 'StartAttachedFileUploadResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ServiceQuotaExceededException', ], ], ], 'StartChatContact' => [ 'name' => 'StartChatContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/chat', ], 'input' => [ 'shape' => 'StartChatContactRequest', ], 'output' => [ 'shape' => 'StartChatContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'StartContactEvaluation' => [ 'name' => 'StartContactEvaluation', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact-evaluations/{InstanceId}', ], 'input' => [ 'shape' => 'StartContactEvaluationRequest', ], 'output' => [ 'shape' => 'StartContactEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'StartContactRecording' => [ 'name' => 'StartContactRecording', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/start-recording', ], 'input' => [ 'shape' => 'StartContactRecordingRequest', ], 'output' => [ 'shape' => 'StartContactRecordingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'StartContactStreaming' => [ 'name' => 'StartContactStreaming', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/start-streaming', ], 'input' => [ 'shape' => 'StartContactStreamingRequest', ], 'output' => [ 'shape' => 'StartContactStreamingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'StartOutboundVoiceContact' => [ 'name' => 'StartOutboundVoiceContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/outbound-voice', ], 'input' => [ 'shape' => 'StartOutboundVoiceContactRequest', ], 'output' => [ 'shape' => 'StartOutboundVoiceContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'DestinationNotAllowedException', ], [ 'shape' => 'OutboundContactNotPermittedException', ], ], ], 'StartTaskContact' => [ 'name' => 'StartTaskContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/task', ], 'input' => [ 'shape' => 'StartTaskContactRequest', ], 'output' => [ 'shape' => 'StartTaskContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'StartWebRTCContact' => [ 'name' => 'StartWebRTCContact', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/webrtc', ], 'input' => [ 'shape' => 'StartWebRTCContactRequest', ], 'output' => [ 'shape' => 'StartWebRTCContactResponse', ], 'errors' => [ [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'StopContact' => [ 'name' => 'StopContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/stop', ], 'input' => [ 'shape' => 'StopContactRequest', ], 'output' => [ 'shape' => 'StopContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ContactNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'StopContactRecording' => [ 'name' => 'StopContactRecording', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/stop-recording', ], 'input' => [ 'shape' => 'StopContactRecordingRequest', ], 'output' => [ 'shape' => 'StopContactRecordingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'StopContactStreaming' => [ 'name' => 'StopContactStreaming', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/stop-streaming', ], 'input' => [ 'shape' => 'StopContactStreamingRequest', ], 'output' => [ 'shape' => 'StopContactStreamingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'SubmitContactEvaluation' => [ 'name' => 'SubmitContactEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-evaluations/{InstanceId}/{EvaluationId}/submit', ], 'input' => [ 'shape' => 'SubmitContactEvaluationRequest', ], 'output' => [ 'shape' => 'SubmitContactEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'SuspendContactRecording' => [ 'name' => 'SuspendContactRecording', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/suspend-recording', ], 'input' => [ 'shape' => 'SuspendContactRecordingRequest', ], 'output' => [ 'shape' => 'SuspendContactRecordingResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'TagContact' => [ 'name' => 'TagContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/tags', ], 'input' => [ 'shape' => 'TagContactRequest', ], 'output' => [ 'shape' => 'TagContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], 'idempotent' => true, ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'TransferContact' => [ 'name' => 'TransferContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/transfer', ], 'input' => [ 'shape' => 'TransferContactRequest', ], 'output' => [ 'shape' => 'TransferContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UntagContact' => [ 'name' => 'UntagContact', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/contact/tags/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'UntagContactRequest', ], 'output' => [ 'shape' => 'UntagContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], 'idempotent' => true, ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateAgentStatus' => [ 'name' => 'UpdateAgentStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/agent-status/{InstanceId}/{AgentStatusId}', ], 'input' => [ 'shape' => 'UpdateAgentStatusRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContact' => [ 'name' => 'UpdateContact', 'http' => [ 'method' => 'POST', 'requestUri' => '/contacts/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'UpdateContactRequest', ], 'output' => [ 'shape' => 'UpdateContactResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateContactAttributes' => [ 'name' => 'UpdateContactAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/attributes', ], 'input' => [ 'shape' => 'UpdateContactAttributesRequest', ], 'output' => [ 'shape' => 'UpdateContactAttributesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactEvaluation' => [ 'name' => 'UpdateContactEvaluation', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-evaluations/{InstanceId}/{EvaluationId}', ], 'input' => [ 'shape' => 'UpdateContactEvaluationRequest', ], 'output' => [ 'shape' => 'UpdateContactEvaluationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'UpdateContactFlowContent' => [ 'name' => 'UpdateContactFlowContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}/content', ], 'input' => [ 'shape' => 'UpdateContactFlowContentRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowContentResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidContactFlowException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactFlowMetadata' => [ 'name' => 'UpdateContactFlowMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}/metadata', ], 'input' => [ 'shape' => 'UpdateContactFlowMetadataRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowMetadataResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactFlowModuleContent' => [ 'name' => 'UpdateContactFlowModuleContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content', ], 'input' => [ 'shape' => 'UpdateContactFlowModuleContentRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowModuleContentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidContactFlowModuleException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactFlowModuleMetadata' => [ 'name' => 'UpdateContactFlowModuleMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata', ], 'input' => [ 'shape' => 'UpdateContactFlowModuleMetadataRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowModuleMetadataResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactFlowName' => [ 'name' => 'UpdateContactFlowName', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact-flows/{InstanceId}/{ContactFlowId}/name', ], 'input' => [ 'shape' => 'UpdateContactFlowNameRequest', ], 'output' => [ 'shape' => 'UpdateContactFlowNameResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateContactRoutingData' => [ 'name' => 'UpdateContactRoutingData', 'http' => [ 'method' => 'POST', 'requestUri' => '/contacts/{InstanceId}/{ContactId}/routing-data', ], 'input' => [ 'shape' => 'UpdateContactRoutingDataRequest', ], 'output' => [ 'shape' => 'UpdateContactRoutingDataResponse', ], 'errors' => [ [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdateContactSchedule' => [ 'name' => 'UpdateContactSchedule', 'http' => [ 'method' => 'POST', 'requestUri' => '/contact/schedule', ], 'input' => [ 'shape' => 'UpdateContactScheduleRequest', ], 'output' => [ 'shape' => 'UpdateContactScheduleResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateEvaluationForm' => [ 'name' => 'UpdateEvaluationForm', 'http' => [ 'method' => 'PUT', 'requestUri' => '/evaluation-forms/{InstanceId}/{EvaluationFormId}', ], 'input' => [ 'shape' => 'UpdateEvaluationFormRequest', ], 'output' => [ 'shape' => 'UpdateEvaluationFormResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'ResourceConflictException', ], ], 'idempotent' => true, ], 'UpdateHoursOfOperation' => [ 'name' => 'UpdateHoursOfOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/hours-of-operations/{InstanceId}/{HoursOfOperationId}', ], 'input' => [ 'shape' => 'UpdateHoursOfOperationRequest', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateInstanceAttribute' => [ 'name' => 'UpdateInstanceAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/attribute/{AttributeType}', ], 'input' => [ 'shape' => 'UpdateInstanceAttributeRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateInstanceStorageConfig' => [ 'name' => 'UpdateInstanceStorageConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/storage-config/{AssociationId}', ], 'input' => [ 'shape' => 'UpdateInstanceStorageConfigRequest', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'UpdateParticipantRoleConfig' => [ 'name' => 'UpdateParticipantRoleConfig', 'http' => [ 'method' => 'PUT', 'requestUri' => '/contact/participant-role-config/{InstanceId}/{ContactId}', ], 'input' => [ 'shape' => 'UpdateParticipantRoleConfigRequest', ], 'output' => [ 'shape' => 'UpdateParticipantRoleConfigResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdatePhoneNumber' => [ 'name' => 'UpdatePhoneNumber', 'http' => [ 'method' => 'PUT', 'requestUri' => '/phone-number/{PhoneNumberId}', ], 'input' => [ 'shape' => 'UpdatePhoneNumberRequest', ], 'output' => [ 'shape' => 'UpdatePhoneNumberResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UpdatePhoneNumberMetadata' => [ 'name' => 'UpdatePhoneNumberMetadata', 'http' => [ 'method' => 'PUT', 'requestUri' => '/phone-number/{PhoneNumberId}/metadata', ], 'input' => [ 'shape' => 'UpdatePhoneNumberMetadataRequest', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdatePredefinedAttribute' => [ 'name' => 'UpdatePredefinedAttribute', 'http' => [ 'method' => 'POST', 'requestUri' => '/predefined-attributes/{InstanceId}/{Name}', ], 'input' => [ 'shape' => 'UpdatePredefinedAttributeRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdatePrompt' => [ 'name' => 'UpdatePrompt', 'http' => [ 'method' => 'POST', 'requestUri' => '/prompts/{InstanceId}/{PromptId}', ], 'input' => [ 'shape' => 'UpdatePromptRequest', ], 'output' => [ 'shape' => 'UpdatePromptResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueHoursOfOperation' => [ 'name' => 'UpdateQueueHoursOfOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/hours-of-operation', ], 'input' => [ 'shape' => 'UpdateQueueHoursOfOperationRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueMaxContacts' => [ 'name' => 'UpdateQueueMaxContacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/max-contacts', ], 'input' => [ 'shape' => 'UpdateQueueMaxContactsRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueName' => [ 'name' => 'UpdateQueueName', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/name', ], 'input' => [ 'shape' => 'UpdateQueueNameRequest', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueOutboundCallerConfig' => [ 'name' => 'UpdateQueueOutboundCallerConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/outbound-caller-config', ], 'input' => [ 'shape' => 'UpdateQueueOutboundCallerConfigRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQueueStatus' => [ 'name' => 'UpdateQueueStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/queues/{InstanceId}/{QueueId}/status', ], 'input' => [ 'shape' => 'UpdateQueueStatusRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQuickConnectConfig' => [ 'name' => 'UpdateQuickConnectConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/quick-connects/{InstanceId}/{QuickConnectId}/config', ], 'input' => [ 'shape' => 'UpdateQuickConnectConfigRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateQuickConnectName' => [ 'name' => 'UpdateQuickConnectName', 'http' => [ 'method' => 'POST', 'requestUri' => '/quick-connects/{InstanceId}/{QuickConnectId}/name', ], 'input' => [ 'shape' => 'UpdateQuickConnectNameRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileAgentAvailabilityTimer' => [ 'name' => 'UpdateRoutingProfileAgentAvailabilityTimer', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer', ], 'input' => [ 'shape' => 'UpdateRoutingProfileAgentAvailabilityTimerRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileConcurrency' => [ 'name' => 'UpdateRoutingProfileConcurrency', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency', ], 'input' => [ 'shape' => 'UpdateRoutingProfileConcurrencyRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileDefaultOutboundQueue' => [ 'name' => 'UpdateRoutingProfileDefaultOutboundQueue', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue', ], 'input' => [ 'shape' => 'UpdateRoutingProfileDefaultOutboundQueueRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileName' => [ 'name' => 'UpdateRoutingProfileName', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/name', ], 'input' => [ 'shape' => 'UpdateRoutingProfileNameRequest', ], 'errors' => [ [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRoutingProfileQueues' => [ 'name' => 'UpdateRoutingProfileQueues', 'http' => [ 'method' => 'POST', 'requestUri' => '/routing-profiles/{InstanceId}/{RoutingProfileId}/queues', ], 'input' => [ 'shape' => 'UpdateRoutingProfileQueuesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateRule' => [ 'name' => 'UpdateRule', 'http' => [ 'method' => 'PUT', 'requestUri' => '/rules/{InstanceId}/{RuleId}', ], 'input' => [ 'shape' => 'UpdateRuleRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceConflictException', ], ], ], 'UpdateSecurityProfile' => [ 'name' => 'UpdateSecurityProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/security-profiles/{InstanceId}/{SecurityProfileId}', ], 'input' => [ 'shape' => 'UpdateSecurityProfileRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateTaskTemplate' => [ 'name' => 'UpdateTaskTemplate', 'http' => [ 'method' => 'POST', 'requestUri' => '/instance/{InstanceId}/task/template/{TaskTemplateId}', ], 'input' => [ 'shape' => 'UpdateTaskTemplateRequest', ], 'output' => [ 'shape' => 'UpdateTaskTemplateResponse', ], 'errors' => [ [ 'shape' => 'PropertyValidationException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateTrafficDistribution' => [ 'name' => 'UpdateTrafficDistribution', 'http' => [ 'method' => 'PUT', 'requestUri' => '/traffic-distribution/{Id}', ], 'input' => [ 'shape' => 'UpdateTrafficDistributionRequest', ], 'output' => [ 'shape' => 'UpdateTrafficDistributionResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserHierarchy' => [ 'name' => 'UpdateUserHierarchy', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/hierarchy', ], 'input' => [ 'shape' => 'UpdateUserHierarchyRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserHierarchyGroupName' => [ 'name' => 'UpdateUserHierarchyGroupName', 'http' => [ 'method' => 'POST', 'requestUri' => '/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}/name', ], 'input' => [ 'shape' => 'UpdateUserHierarchyGroupNameRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserHierarchyStructure' => [ 'name' => 'UpdateUserHierarchyStructure', 'http' => [ 'method' => 'POST', 'requestUri' => '/user-hierarchy-structure/{InstanceId}', ], 'input' => [ 'shape' => 'UpdateUserHierarchyStructureRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserIdentityInfo' => [ 'name' => 'UpdateUserIdentityInfo', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/identity-info', ], 'input' => [ 'shape' => 'UpdateUserIdentityInfoRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserPhoneConfig' => [ 'name' => 'UpdateUserPhoneConfig', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/phone-config', ], 'input' => [ 'shape' => 'UpdateUserPhoneConfigRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserProficiencies' => [ 'name' => 'UpdateUserProficiencies', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/proficiencies', ], 'input' => [ 'shape' => 'UpdateUserProficienciesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserRoutingProfile' => [ 'name' => 'UpdateUserRoutingProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/routing-profile', ], 'input' => [ 'shape' => 'UpdateUserRoutingProfileRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateUserSecurityProfiles' => [ 'name' => 'UpdateUserSecurityProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/users/{InstanceId}/{UserId}/security-profiles', ], 'input' => [ 'shape' => 'UpdateUserSecurityProfilesRequest', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServiceException', ], ], ], 'UpdateViewContent' => [ 'name' => 'UpdateViewContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/views/{InstanceId}/{ViewId}', ], 'input' => [ 'shape' => 'UpdateViewContentRequest', ], 'output' => [ 'shape' => 'UpdateViewContentResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'ResourceInUseException', ], ], ], 'UpdateViewMetadata' => [ 'name' => 'UpdateViewMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/views/{InstanceId}/{ViewId}/metadata', ], 'input' => [ 'shape' => 'UpdateViewMetadataRequest', ], 'output' => [ 'shape' => 'UpdateViewMetadataResponse', ], 'errors' => [ [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InternalServiceException', ], [ 'shape' => 'TooManyRequestsException', ], [ 'shape' => 'DuplicateResourceException', ], [ 'shape' => 'ResourceInUseException', ], ], ], ], 'shapes' => [ 'ARN' => [ 'type' => 'string', ], 'AWSAccountId' => [ 'type' => 'string', ], 'AccessDeniedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'ActionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ActionSummary', ], ], 'ActionSummary' => [ 'type' => 'structure', 'required' => [ 'ActionType', ], 'members' => [ 'ActionType' => [ 'shape' => 'ActionType', ], ], ], 'ActionType' => [ 'type' => 'string', 'enum' => [ 'CREATE_TASK', 'ASSIGN_CONTACT_CATEGORY', 'GENERATE_EVENTBRIDGE_EVENT', 'SEND_NOTIFICATION', 'CREATE_CASE', 'UPDATE_CASE', 'END_ASSOCIATED_TASKS', 'SUBMIT_AUTO_EVALUATION', ], ], 'ActivateEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', 'EvaluationFormVersion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'ActivateEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', 'EvaluationFormVersion', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'AfterContactWorkTimeLimit' => [ 'type' => 'integer', 'min' => 0, ], 'AgentAvailabilityTimer' => [ 'type' => 'string', 'enum' => [ 'TIME_SINCE_LAST_ACTIVITY', 'TIME_SINCE_LAST_INBOUND', ], ], 'AgentConfig' => [ 'type' => 'structure', 'required' => [ 'Distributions', ], 'members' => [ 'Distributions' => [ 'shape' => 'DistributionList', ], ], ], 'AgentContactReference' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'Channel' => [ 'shape' => 'Channel', ], 'InitiationMethod' => [ 'shape' => 'ContactInitiationMethod', ], 'AgentContactState' => [ 'shape' => 'ContactState', ], 'StateStartTimestamp' => [ 'shape' => 'Timestamp', ], 'ConnectedToAgentTimestamp' => [ 'shape' => 'Timestamp', ], 'Queue' => [ 'shape' => 'QueueReference', ], ], ], 'AgentContactReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentContactReference', ], ], 'AgentFirstName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'sensitive' => true, ], 'AgentHierarchyGroup' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], ], ], 'AgentHierarchyGroups' => [ 'type' => 'structure', 'members' => [ 'L1Ids' => [ 'shape' => 'HierarchyGroupIdList', ], 'L2Ids' => [ 'shape' => 'HierarchyGroupIdList', ], 'L3Ids' => [ 'shape' => 'HierarchyGroupIdList', ], 'L4Ids' => [ 'shape' => 'HierarchyGroupIdList', ], 'L5Ids' => [ 'shape' => 'HierarchyGroupIdList', ], ], ], 'AgentId' => [ 'type' => 'string', 'max' => 256, ], 'AgentIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentId', ], ], 'AgentInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'AgentResourceId', ], 'ConnectedToAgentTimestamp' => [ 'shape' => 'timestamp', ], 'AgentPauseDurationInSeconds' => [ 'shape' => 'AgentPauseDurationInSeconds', ], 'HierarchyGroups' => [ 'shape' => 'HierarchyGroups', ], 'DeviceInfo' => [ 'shape' => 'DeviceInfo', ], 'Capabilities' => [ 'shape' => 'ParticipantCapabilities', ], ], ], 'AgentLastName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'sensitive' => true, ], 'AgentPauseDurationInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'AgentQualityMetrics' => [ 'type' => 'structure', 'members' => [ 'Audio' => [ 'shape' => 'AudioQualityMetricsInfo', ], ], ], 'AgentResourceId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'AgentResourceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentResourceId', ], 'max' => 100, 'min' => 0, ], 'AgentStatus' => [ 'type' => 'structure', 'members' => [ 'AgentStatusARN' => [ 'shape' => 'ARN', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', ], 'Name' => [ 'shape' => 'AgentStatusName', ], 'Description' => [ 'shape' => 'AgentStatusDescription', ], 'Type' => [ 'shape' => 'AgentStatusType', ], 'DisplayOrder' => [ 'shape' => 'AgentStatusOrderNumber', ], 'State' => [ 'shape' => 'AgentStatusState', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'AgentStatusDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'AgentStatusId' => [ 'type' => 'string', ], 'AgentStatusName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'AgentStatusOrderNumber' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'AgentStatusReference' => [ 'type' => 'structure', 'members' => [ 'StatusStartTimestamp' => [ 'shape' => 'Timestamp', ], 'StatusArn' => [ 'shape' => 'ARN', ], 'StatusName' => [ 'shape' => 'AgentStatusName', ], ], ], 'AgentStatusState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'AgentStatusSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'AgentStatusId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'AgentStatusName', ], 'Type' => [ 'shape' => 'AgentStatusType', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'AgentStatusSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentStatusSummary', ], ], 'AgentStatusType' => [ 'type' => 'string', 'enum' => [ 'ROUTABLE', 'CUSTOM', 'OFFLINE', ], ], 'AgentStatusTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentStatusType', ], 'max' => 3, ], 'AgentUsername' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AgentsCriteria' => [ 'type' => 'structure', 'members' => [ 'AgentIds' => [ 'shape' => 'AgentIds', ], ], ], 'AgentsMinOneMaxHundred' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserId', ], 'max' => 100, 'min' => 1, ], 'AliasArn' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AllowedAccessControlTags' => [ 'type' => 'map', 'key' => [ 'shape' => 'SecurityProfilePolicyKey', ], 'value' => [ 'shape' => 'SecurityProfilePolicyValue', ], 'max' => 2, ], 'AllowedCapabilities' => [ 'type' => 'structure', 'members' => [ 'Customer' => [ 'shape' => 'ParticipantCapabilities', ], 'Agent' => [ 'shape' => 'ParticipantCapabilities', ], ], ], 'AllowedMonitorCapabilities' => [ 'type' => 'list', 'member' => [ 'shape' => 'MonitorCapability', ], 'max' => 2, ], 'AnalyticsDataAssociationResult' => [ 'type' => 'structure', 'members' => [ 'DataSetId' => [ 'shape' => 'DataSetId', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], 'ResourceShareId' => [ 'shape' => 'String', ], 'ResourceShareArn' => [ 'shape' => 'ARN', ], ], ], 'AnalyticsDataAssociationResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalyticsDataAssociationResult', ], ], 'AnswerMachineDetectionConfig' => [ 'type' => 'structure', 'members' => [ 'EnableAnswerMachineDetection' => [ 'shape' => 'Boolean', ], 'AwaitAnswerMachinePrompt' => [ 'shape' => 'Boolean', ], ], ], 'AnsweringMachineDetectionStatus' => [ 'type' => 'string', 'enum' => [ 'ANSWERED', 'UNDETECTED', 'ERROR', 'HUMAN_ANSWERED', 'SIT_TONE_DETECTED', 'SIT_TONE_BUSY', 'SIT_TONE_INVALID_NUMBER', 'FAX_MACHINE_DETECTED', 'VOICEMAIL_BEEP', 'VOICEMAIL_NO_BEEP', 'AMD_UNRESOLVED', 'AMD_UNANSWERED', 'AMD_ERROR', 'AMD_NOT_APPLICABLE', ], ], 'Application' => [ 'type' => 'structure', 'members' => [ 'Namespace' => [ 'shape' => 'Namespace', ], 'ApplicationPermissions' => [ 'shape' => 'ApplicationPermissions', ], ], ], 'ApplicationPermissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Permission', ], 'max' => 10, 'min' => 1, ], 'Applications' => [ 'type' => 'list', 'member' => [ 'shape' => 'Application', ], 'max' => 10, ], 'ApproximateTotalCount' => [ 'type' => 'long', ], 'ArtifactId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ArtifactStatus' => [ 'type' => 'string', 'enum' => [ 'APPROVED', 'REJECTED', 'IN_PROGRESS', ], ], 'AssignContactCategoryActionDefinition' => [ 'type' => 'structure', 'members' => [], ], 'AssociateAnalyticsDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'DataSetId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetId' => [ 'shape' => 'DataSetId', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'AssociateAnalyticsDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'DataSetId' => [ 'shape' => 'DataSetId', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], 'ResourceShareId' => [ 'shape' => 'String', ], 'ResourceShareArn' => [ 'shape' => 'ARN', ], ], ], 'AssociateApprovedOriginRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Origin', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Origin' => [ 'shape' => 'Origin', ], ], ], 'AssociateBotRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LexBot' => [ 'shape' => 'LexBot', ], 'LexV2Bot' => [ 'shape' => 'LexV2Bot', ], ], ], 'AssociateDefaultVocabularyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'LanguageCode', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', 'location' => 'uri', 'locationName' => 'LanguageCode', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', ], ], ], 'AssociateDefaultVocabularyResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociateFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceId', 'FlowId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceId' => [ 'shape' => 'ARN', ], 'FlowId' => [ 'shape' => 'ARN', ], 'ResourceType' => [ 'shape' => 'FlowAssociationResourceType', ], ], ], 'AssociateFlowResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociateInstanceStorageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceType', 'StorageConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', ], 'StorageConfig' => [ 'shape' => 'InstanceStorageConfig', ], ], ], 'AssociateInstanceStorageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationId' => [ 'shape' => 'AssociationId', ], ], ], 'AssociateLambdaFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FunctionArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FunctionArn' => [ 'shape' => 'FunctionArn', ], ], ], 'AssociateLexBotRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'LexBot', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LexBot' => [ 'shape' => 'LexBot', ], ], ], 'AssociatePhoneNumberContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', 'InstanceId', 'ContactFlowId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'AssociateQueueQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'QuickConnectIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'QuickConnectIds' => [ 'shape' => 'QuickConnectsList', ], ], ], 'AssociateRoutingProfileQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'QueueConfigs', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'QueueConfigs' => [ 'shape' => 'RoutingProfileQueueConfigList', ], ], ], 'AssociateSecurityKeyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Key', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Key' => [ 'shape' => 'PEM', ], ], ], 'AssociateSecurityKeyResponse' => [ 'type' => 'structure', 'members' => [ 'AssociationId' => [ 'shape' => 'AssociationId', ], ], ], 'AssociateTrafficDistributionGroupUserRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', 'UserId', 'InstanceId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], 'UserId' => [ 'shape' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], ], ], 'AssociateTrafficDistributionGroupUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociateUserProficienciesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', 'UserProficiencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'UserProficiencies' => [ 'shape' => 'UserProficiencyList', ], ], ], 'AssociatedQueueIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueId', ], ], 'AssociationId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'AttachedFile' => [ 'type' => 'structure', 'required' => [ 'CreationTime', 'FileArn', 'FileId', 'FileName', 'FileSizeInBytes', 'FileStatus', ], 'members' => [ 'CreationTime' => [ 'shape' => 'ISO8601Datetime', ], 'FileArn' => [ 'shape' => 'ARN', ], 'FileId' => [ 'shape' => 'FileId', ], 'FileName' => [ 'shape' => 'FileName', ], 'FileSizeInBytes' => [ 'shape' => 'FileSizeInBytes', 'box' => true, ], 'FileStatus' => [ 'shape' => 'FileStatusType', ], 'CreatedBy' => [ 'shape' => 'CreatedByInfo', ], 'FileUseCaseType' => [ 'shape' => 'FileUseCaseType', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'AttachedFileError' => [ 'type' => 'structure', 'members' => [ 'ErrorCode' => [ 'shape' => 'ErrorCode', ], 'ErrorMessage' => [ 'shape' => 'ErrorMessage', ], 'FileId' => [ 'shape' => 'FileId', ], ], ], 'AttachedFileErrorsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachedFileError', ], ], 'AttachedFileInvalidRequestExceptionReason' => [ 'type' => 'string', 'enum' => [ 'INVALID_FILE_SIZE', 'INVALID_FILE_TYPE', 'INVALID_FILE_NAME', ], ], 'AttachedFilesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachedFile', ], ], 'AttachmentName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'AttachmentReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], 'Status' => [ 'shape' => 'ReferenceStatus', ], ], ], 'Attendee' => [ 'type' => 'structure', 'members' => [ 'AttendeeId' => [ 'shape' => 'AttendeeId', ], 'JoinToken' => [ 'shape' => 'JoinToken', ], ], ], 'AttendeeId' => [ 'type' => 'string', ], 'Attribute' => [ 'type' => 'structure', 'members' => [ 'AttributeType' => [ 'shape' => 'InstanceAttributeType', ], 'Value' => [ 'shape' => 'InstanceAttributeValue', ], ], ], 'AttributeAndCondition' => [ 'type' => 'structure', 'members' => [ 'TagConditions' => [ 'shape' => 'TagAndConditionList', ], 'HierarchyGroupCondition' => [ 'shape' => 'HierarchyGroupCondition', ], ], ], 'AttributeCondition' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'PredefinedAttributeName', ], 'Value' => [ 'shape' => 'ProficiencyValue', ], 'ProficiencyLevel' => [ 'shape' => 'NullableProficiencyLevel', ], 'MatchCriteria' => [ 'shape' => 'MatchCriteria', ], 'ComparisonOperator' => [ 'shape' => 'ComparisonOperator', ], ], ], 'AttributeName' => [ 'type' => 'string', 'max' => 32767, 'min' => 1, ], 'AttributeOrConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttributeAndCondition', ], ], 'AttributeValue' => [ 'type' => 'string', 'max' => 32767, 'min' => 0, ], 'Attributes' => [ 'type' => 'map', 'key' => [ 'shape' => 'AttributeName', ], 'value' => [ 'shape' => 'AttributeValue', ], ], 'AttributesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attribute', ], ], 'AudioFeatures' => [ 'type' => 'structure', 'members' => [ 'EchoReduction' => [ 'shape' => 'MeetingFeatureStatus', ], ], ], 'AudioQualityMetricsInfo' => [ 'type' => 'structure', 'members' => [ 'QualityScore' => [ 'shape' => 'AudioQualityScore', ], 'PotentialQualityIssues' => [ 'shape' => 'PotentialAudioQualityIssues', ], ], ], 'AudioQualityScore' => [ 'type' => 'float', ], 'AutoAccept' => [ 'type' => 'boolean', ], 'AvailableNumberSummary' => [ 'type' => 'structure', 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], ], ], 'AvailableNumbersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailableNumberSummary', ], ], 'AwsRegion' => [ 'type' => 'string', 'max' => 31, 'min' => 8, 'pattern' => '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?', ], 'BatchAssociateAnalyticsDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'DataSetIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetIds' => [ 'shape' => 'DataSetIds', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'BatchAssociateAnalyticsDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Created' => [ 'shape' => 'AnalyticsDataAssociationResults', ], 'Errors' => [ 'shape' => 'ErrorResults', ], ], ], 'BatchDisassociateAnalyticsDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'DataSetIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetIds' => [ 'shape' => 'DataSetIds', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'BatchDisassociateAnalyticsDataSetResponse' => [ 'type' => 'structure', 'members' => [ 'Deleted' => [ 'shape' => 'DataSetIds', ], 'Errors' => [ 'shape' => 'ErrorResults', ], ], ], 'BatchGetAttachedFileMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'FileIds', 'InstanceId', 'AssociatedResourceArn', ], 'members' => [ 'FileIds' => [ 'shape' => 'FileIdList', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], ], ], 'BatchGetAttachedFileMetadataResponse' => [ 'type' => 'structure', 'members' => [ 'Files' => [ 'shape' => 'AttachedFilesList', ], 'Errors' => [ 'shape' => 'AttachedFileErrorsList', ], ], ], 'BatchGetFlowAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceIds' => [ 'shape' => 'resourceArnListMaxLimit100', ], 'ResourceType' => [ 'shape' => 'ListFlowAssociationResourceType', ], ], ], 'BatchGetFlowAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'FlowAssociationSummaryList' => [ 'shape' => 'FlowAssociationSummaryList', ], ], ], 'BatchPutContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactDataRequestList', ], 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactDataRequestList' => [ 'shape' => 'ContactDataRequestList', ], ], ], 'BatchPutContactResponse' => [ 'type' => 'structure', 'members' => [ 'SuccessfulRequestList' => [ 'shape' => 'SuccessfulRequestList', ], 'FailedRequestList' => [ 'shape' => 'FailedRequestList', ], ], ], 'BehaviorType' => [ 'type' => 'string', 'enum' => [ 'ROUTE_CURRENT_CHANNEL_ONLY', 'ROUTE_ANY_CHANNEL', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BotName' => [ 'type' => 'string', 'max' => 50, ], 'BoxedBoolean' => [ 'type' => 'boolean', ], 'BucketName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'Campaign' => [ 'type' => 'structure', 'members' => [ 'CampaignId' => [ 'shape' => 'CampaignId', ], ], ], 'CampaignId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'Channel' => [ 'type' => 'string', 'enum' => [ 'VOICE', 'CHAT', 'TASK', ], ], 'ChannelList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], ], 'ChannelToCountMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'Channel', ], 'value' => [ 'shape' => 'IntegerCount', ], ], 'Channels' => [ 'type' => 'list', 'member' => [ 'shape' => 'Channel', ], 'max' => 3, ], 'ChatContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, ], 'ChatContentType' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'ChatDurationInMinutes' => [ 'type' => 'integer', 'max' => 10080, 'min' => 60, ], 'ChatEvent' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'Type' => [ 'shape' => 'ChatEventType', ], 'ContentType' => [ 'shape' => 'ChatContentType', ], 'Content' => [ 'shape' => 'ChatContent', ], ], ], 'ChatEventType' => [ 'type' => 'string', 'enum' => [ 'DISCONNECT', 'MESSAGE', 'EVENT', ], ], 'ChatMessage' => [ 'type' => 'structure', 'required' => [ 'ContentType', 'Content', ], 'members' => [ 'ContentType' => [ 'shape' => 'ChatContentType', ], 'Content' => [ 'shape' => 'ChatContent', ], ], ], 'ChatParticipantRoleConfig' => [ 'type' => 'structure', 'required' => [ 'ParticipantTimerConfigList', ], 'members' => [ 'ParticipantTimerConfigList' => [ 'shape' => 'ParticipantTimerConfigList', ], ], ], 'ChatStreamingConfiguration' => [ 'type' => 'structure', 'required' => [ 'StreamingEndpointArn', ], 'members' => [ 'StreamingEndpointArn' => [ 'shape' => 'ChatStreamingEndpointARN', ], ], ], 'ChatStreamingEndpointARN' => [ 'type' => 'string', 'max' => 350, 'min' => 1, ], 'ClaimPhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumber', ], 'members' => [ 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'ClaimPhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'ClaimedPhoneNumberSummary' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Tags' => [ 'shape' => 'TagMap', ], 'PhoneNumberStatus' => [ 'shape' => 'PhoneNumberStatus', ], 'SourcePhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 500, ], 'CommonNameLength127' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'Comparison' => [ 'type' => 'string', 'enum' => [ 'LT', ], ], 'ComparisonOperator' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'CompleteAttachedFileUploadRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FileId', 'AssociatedResourceArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FileId' => [ 'shape' => 'FileId', 'location' => 'uri', 'locationName' => 'FileId', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], ], ], 'CompleteAttachedFileUploadResponse' => [ 'type' => 'structure', 'members' => [], ], 'Concurrency' => [ 'type' => 'integer', 'max' => 10, 'min' => 1, ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectionData' => [ 'type' => 'structure', 'members' => [ 'Attendee' => [ 'shape' => 'Attendee', ], 'Meeting' => [ 'shape' => 'Meeting', ], ], ], 'Contact' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'Id' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], 'PreviousContactId' => [ 'shape' => 'ContactId', ], 'InitiationMethod' => [ 'shape' => 'ContactInitiationMethod', ], 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'Channel' => [ 'shape' => 'Channel', ], 'QueueInfo' => [ 'shape' => 'QueueInfo', ], 'AgentInfo' => [ 'shape' => 'AgentInfo', ], 'InitiationTimestamp' => [ 'shape' => 'timestamp', ], 'DisconnectTimestamp' => [ 'shape' => 'timestamp', ], 'LastUpdateTimestamp' => [ 'shape' => 'timestamp', ], 'LastPausedTimestamp' => [ 'shape' => 'timestamp', ], 'LastResumedTimestamp' => [ 'shape' => 'timestamp', ], 'TotalPauseCount' => [ 'shape' => 'TotalPauseCount', ], 'TotalPauseDurationInSeconds' => [ 'shape' => 'TotalPauseDurationInSeconds', ], 'ScheduledTimestamp' => [ 'shape' => 'timestamp', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], 'WisdomInfo' => [ 'shape' => 'WisdomInfo', ], 'QueueTimeAdjustmentSeconds' => [ 'shape' => 'QueueTimeAdjustmentSeconds', ], 'QueuePriority' => [ 'shape' => 'QueuePriority', ], 'Tags' => [ 'shape' => 'ContactTagMap', ], 'ConnectedToSystemTimestamp' => [ 'shape' => 'timestamp', ], 'RoutingCriteria' => [ 'shape' => 'RoutingCriteria', ], 'Customer' => [ 'shape' => 'Customer', ], 'Campaign' => [ 'shape' => 'Campaign', ], 'AnsweringMachineDetectionStatus' => [ 'shape' => 'AnsweringMachineDetectionStatus', ], 'CustomerVoiceActivity' => [ 'shape' => 'CustomerVoiceActivity', ], 'QualityMetrics' => [ 'shape' => 'QualityMetrics', ], 'DisconnectDetails' => [ 'shape' => 'DisconnectDetails', ], 'SegmentAttributes' => [ 'shape' => 'SegmentAttributes', ], ], ], 'ContactAnalysis' => [ 'type' => 'structure', 'members' => [ 'Transcript' => [ 'shape' => 'Transcript', ], ], ], 'ContactDataRequest' => [ 'type' => 'structure', 'members' => [ 'SystemEndpoint' => [ 'shape' => 'Endpoint', ], 'CustomerEndpoint' => [ 'shape' => 'Endpoint', ], 'RequestIdentifier' => [ 'shape' => 'RequestIdentifier', ], 'QueueId' => [ 'shape' => 'QueueId', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'Campaign' => [ 'shape' => 'Campaign', ], ], ], 'ContactDataRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactDataRequest', ], 'max' => 25, 'min' => 1, ], 'ContactFilter' => [ 'type' => 'structure', 'members' => [ 'ContactStates' => [ 'shape' => 'ContactStates', ], ], ], 'ContactFlow' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'Id' => [ 'shape' => 'ContactFlowId', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'Type' => [ 'shape' => 'ContactFlowType', ], 'State' => [ 'shape' => 'ContactFlowState', ], 'Status' => [ 'shape' => 'ContactFlowStatus', ], 'Description' => [ 'shape' => 'ContactFlowDescription', ], 'Content' => [ 'shape' => 'ContactFlowContent', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'ContactFlowContent' => [ 'type' => 'string', ], 'ContactFlowDescription' => [ 'type' => 'string', ], 'ContactFlowId' => [ 'type' => 'string', 'max' => 500, ], 'ContactFlowModule' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'Id' => [ 'shape' => 'ContactFlowModuleId', ], 'Name' => [ 'shape' => 'ContactFlowModuleName', ], 'Content' => [ 'shape' => 'ContactFlowModuleContent', ], 'Description' => [ 'shape' => 'ContactFlowModuleDescription', ], 'State' => [ 'shape' => 'ContactFlowModuleState', ], 'Status' => [ 'shape' => 'ContactFlowModuleStatus', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'ContactFlowModuleContent' => [ 'type' => 'string', 'max' => 256000, 'min' => 1, ], 'ContactFlowModuleDescription' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '.*\\S.*', ], 'ContactFlowModuleId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContactFlowModuleName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '.*\\S.*', ], 'ContactFlowModuleSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowModuleSearchCriteria', ], ], 'ContactFlowModuleSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'ContactFlowModuleSearchConditionList', ], 'AndConditions' => [ 'shape' => 'ContactFlowModuleSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'ContactFlowModuleSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'ContactFlowModuleSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowModule', ], ], 'ContactFlowModuleState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'ARCHIVED', ], ], 'ContactFlowModuleStatus' => [ 'type' => 'string', 'enum' => [ 'PUBLISHED', 'SAVED', ], ], 'ContactFlowModuleSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ContactFlowModuleId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'ContactFlowModuleName', ], 'State' => [ 'shape' => 'ContactFlowModuleState', ], ], ], 'ContactFlowModulesSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowModuleSummary', ], ], 'ContactFlowName' => [ 'type' => 'string', 'min' => 1, ], 'ContactFlowNotPublishedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ContactFlowSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowSearchCriteria', ], ], 'ContactFlowSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'ContactFlowSearchConditionList', ], 'AndConditions' => [ 'shape' => 'ContactFlowSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], 'TypeCondition' => [ 'shape' => 'ContactFlowType', ], 'StateCondition' => [ 'shape' => 'ContactFlowState', ], 'StatusCondition' => [ 'shape' => 'ContactFlowStatus', ], ], ], 'ContactFlowSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'ContactFlowSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlow', ], ], 'ContactFlowState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'ARCHIVED', ], ], 'ContactFlowStatus' => [ 'type' => 'string', 'enum' => [ 'PUBLISHED', 'SAVED', ], ], 'ContactFlowSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ContactFlowId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'ContactFlowType' => [ 'shape' => 'ContactFlowType', ], 'ContactFlowState' => [ 'shape' => 'ContactFlowState', ], 'ContactFlowStatus' => [ 'shape' => 'ContactFlowStatus', ], ], ], 'ContactFlowSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowSummary', ], ], 'ContactFlowType' => [ 'type' => 'string', 'enum' => [ 'CONTACT_FLOW', 'CUSTOMER_QUEUE', 'CUSTOMER_HOLD', 'CUSTOMER_WHISPER', 'AGENT_HOLD', 'AGENT_WHISPER', 'OUTBOUND_WHISPER', 'AGENT_TRANSFER', 'QUEUE_TRANSFER', ], ], 'ContactFlowTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactFlowType', ], 'max' => 10, ], 'ContactId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ContactInitiationMethod' => [ 'type' => 'string', 'enum' => [ 'INBOUND', 'OUTBOUND', 'TRANSFER', 'QUEUE_TRANSFER', 'CALLBACK', 'API', 'DISCONNECT', 'MONITOR', 'EXTERNAL_OUTBOUND', ], ], 'ContactNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 410, ], 'exception' => true, ], 'ContactReferences' => [ 'type' => 'map', 'key' => [ 'shape' => 'ReferenceKey', ], 'value' => [ 'shape' => 'Reference', ], ], 'ContactSearchSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'Id' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], 'PreviousContactId' => [ 'shape' => 'ContactId', ], 'InitiationMethod' => [ 'shape' => 'ContactInitiationMethod', ], 'Channel' => [ 'shape' => 'Channel', ], 'QueueInfo' => [ 'shape' => 'ContactSearchSummaryQueueInfo', ], 'AgentInfo' => [ 'shape' => 'ContactSearchSummaryAgentInfo', ], 'InitiationTimestamp' => [ 'shape' => 'timestamp', ], 'DisconnectTimestamp' => [ 'shape' => 'timestamp', ], 'ScheduledTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'ContactSearchSummaryAgentInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'AgentResourceId', ], 'ConnectedToAgentTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'ContactSearchSummaryQueueInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QueueId', ], 'EnqueueTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'ContactState' => [ 'type' => 'string', 'enum' => [ 'INCOMING', 'PENDING', 'CONNECTING', 'CONNECTED', 'CONNECTED_ONHOLD', 'MISSED', 'ERROR', 'ENDED', 'REJECTED', ], ], 'ContactStates' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactState', ], 'max' => 9, ], 'ContactTagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^(?!aws:)[a-zA-Z+-=._:/]+$', ], 'ContactTagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactTagKey', ], 'max' => 6, 'min' => 1, ], 'ContactTagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ContactTagKey', ], 'value' => [ 'shape' => 'ContactTagValue', ], 'max' => 6, 'min' => 1, ], 'ContactTagValue' => [ 'type' => 'string', 'max' => 256, ], 'Contacts' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactSearchSummary', ], ], 'Content' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ContentType' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ControlPlaneTagFilter' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'TagOrConditionList', ], 'AndConditions' => [ 'shape' => 'TagAndConditionList', ], 'TagCondition' => [ 'shape' => 'TagCondition', ], ], ], 'ControlPlaneUserAttributeFilter' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'AttributeOrConditionList', ], 'AndCondition' => [ 'shape' => 'AttributeAndCondition', ], 'TagCondition' => [ 'shape' => 'TagCondition', ], 'HierarchyGroupCondition' => [ 'shape' => 'HierarchyGroupCondition', ], ], ], 'CreateAgentStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'State', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'AgentStatusName', ], 'Description' => [ 'shape' => 'AgentStatusDescription', ], 'State' => [ 'shape' => 'AgentStatusState', ], 'DisplayOrder' => [ 'shape' => 'AgentStatusOrderNumber', 'box' => true, ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateAgentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'AgentStatusARN' => [ 'shape' => 'ARN', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', ], ], ], 'CreateCaseActionDefinition' => [ 'type' => 'structure', 'required' => [ 'Fields', 'TemplateId', ], 'members' => [ 'Fields' => [ 'shape' => 'FieldValues', ], 'TemplateId' => [ 'shape' => 'TemplateId', ], ], ], 'CreateContactFlowModuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'ContactFlowModuleName', ], 'Description' => [ 'shape' => 'ContactFlowModuleDescription', ], 'Content' => [ 'shape' => 'ContactFlowModuleContent', ], 'Tags' => [ 'shape' => 'TagMap', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateContactFlowModuleResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ContactFlowModuleId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'CreateContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Type', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'Type' => [ 'shape' => 'ContactFlowType', ], 'Description' => [ 'shape' => 'ContactFlowDescription', ], 'Content' => [ 'shape' => 'ContactFlowContent', ], 'Status' => [ 'shape' => 'ContactFlowStatus', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateContactFlowResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'ContactFlowArn' => [ 'shape' => 'ARN', ], ], ], 'CreateEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Title', 'Items', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'Description' => [ 'shape' => 'EvaluationFormDescription', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'ScoringStrategy' => [ 'shape' => 'EvaluationFormScoringStrategy', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], ], ], 'CreateHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'TimeZone', 'Config', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'HoursOfOperationDescription', ], 'TimeZone' => [ 'shape' => 'TimeZone', ], 'Config' => [ 'shape' => 'HoursOfOperationConfigList', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateHoursOfOperationResponse' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], 'HoursOfOperationArn' => [ 'shape' => 'ARN', ], ], ], 'CreateInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'IdentityManagementType', 'InboundCallsEnabled', 'OutboundCallsEnabled', ], 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', ], 'IdentityManagementType' => [ 'shape' => 'DirectoryType', ], 'InstanceAlias' => [ 'shape' => 'DirectoryAlias', ], 'DirectoryId' => [ 'shape' => 'DirectoryId', ], 'InboundCallsEnabled' => [ 'shape' => 'InboundCallsEnabled', ], 'OutboundCallsEnabled' => [ 'shape' => 'OutboundCallsEnabled', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'CreateIntegrationAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationType', 'IntegrationArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationType' => [ 'shape' => 'IntegrationType', ], 'IntegrationArn' => [ 'shape' => 'ARN', ], 'SourceApplicationUrl' => [ 'shape' => 'URI', ], 'SourceApplicationName' => [ 'shape' => 'SourceApplicationName', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateIntegrationAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', ], 'IntegrationAssociationArn' => [ 'shape' => 'ARN', ], ], ], 'CreateParticipantRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ParticipantDetails', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ParticipantDetails' => [ 'shape' => 'ParticipantDetailsToAdd', ], ], ], 'CreateParticipantResponse' => [ 'type' => 'structure', 'members' => [ 'ParticipantCredentials' => [ 'shape' => 'ParticipantTokenCredentials', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], ], ], 'CreatePersistentContactAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'InitialContactId', 'RehydrationType', 'SourceContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'InitialContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'InitialContactId', ], 'RehydrationType' => [ 'shape' => 'RehydrationType', ], 'SourceContactId' => [ 'shape' => 'ContactId', ], 'ClientToken' => [ 'shape' => 'ClientToken', ], ], ], 'CreatePersistentContactAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'ContinuedFromContactId' => [ 'shape' => 'ContactId', ], ], ], 'CreatePredefinedAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Values', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'PredefinedAttributeName', ], 'Values' => [ 'shape' => 'PredefinedAttributeValues', ], ], ], 'CreatePromptRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'S3Uri', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'PromptDescription', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreatePromptResponse' => [ 'type' => 'structure', 'members' => [ 'PromptARN' => [ 'shape' => 'ARN', ], 'PromptId' => [ 'shape' => 'PromptId', ], ], ], 'CreateQueueRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'QueueDescription', ], 'OutboundCallerConfig' => [ 'shape' => 'OutboundCallerConfig', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], 'MaxContacts' => [ 'shape' => 'QueueMaxContacts', 'box' => true, ], 'QuickConnectIds' => [ 'shape' => 'QuickConnectsList', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateQueueResponse' => [ 'type' => 'structure', 'members' => [ 'QueueArn' => [ 'shape' => 'ARN', ], 'QueueId' => [ 'shape' => 'QueueId', ], ], ], 'CreateQuickConnectRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'QuickConnectConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'QuickConnectName', ], 'Description' => [ 'shape' => 'QuickConnectDescription', ], 'QuickConnectConfig' => [ 'shape' => 'QuickConnectConfig', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateQuickConnectResponse' => [ 'type' => 'structure', 'members' => [ 'QuickConnectARN' => [ 'shape' => 'ARN', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', ], ], ], 'CreateRoutingProfileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Description', 'DefaultOutboundQueueId', 'MediaConcurrencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'RoutingProfileName', ], 'Description' => [ 'shape' => 'RoutingProfileDescription', ], 'DefaultOutboundQueueId' => [ 'shape' => 'QueueId', ], 'QueueConfigs' => [ 'shape' => 'RoutingProfileQueueConfigList', ], 'MediaConcurrencies' => [ 'shape' => 'MediaConcurrencies', ], 'Tags' => [ 'shape' => 'TagMap', ], 'AgentAvailabilityTimer' => [ 'shape' => 'AgentAvailabilityTimer', ], ], ], 'CreateRoutingProfileResponse' => [ 'type' => 'structure', 'members' => [ 'RoutingProfileArn' => [ 'shape' => 'ARN', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], ], ], 'CreateRuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'TriggerEventSource', 'Function', 'Actions', 'PublishStatus', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'RuleName', ], 'TriggerEventSource' => [ 'shape' => 'RuleTriggerEventSource', ], 'Function' => [ 'shape' => 'RuleFunction', ], 'Actions' => [ 'shape' => 'RuleActions', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateRuleResponse' => [ 'type' => 'structure', 'required' => [ 'RuleArn', 'RuleId', ], 'members' => [ 'RuleArn' => [ 'shape' => 'ARN', ], 'RuleId' => [ 'shape' => 'RuleId', ], ], ], 'CreateSecurityProfileName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, 'pattern' => '^[ a-zA-Z0-9_@-]+$', ], 'CreateSecurityProfileRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileName', 'InstanceId', ], 'members' => [ 'SecurityProfileName' => [ 'shape' => 'CreateSecurityProfileName', ], 'Description' => [ 'shape' => 'SecurityProfileDescription', ], 'Permissions' => [ 'shape' => 'PermissionsList', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Tags' => [ 'shape' => 'TagMap', ], 'AllowedAccessControlTags' => [ 'shape' => 'AllowedAccessControlTags', ], 'TagRestrictedResources' => [ 'shape' => 'TagRestrictedResourceList', ], 'Applications' => [ 'shape' => 'Applications', ], 'HierarchyRestrictedResources' => [ 'shape' => 'HierarchyRestrictedResourceList', ], 'AllowedAccessControlHierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], ], ], 'CreateSecurityProfileResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', ], 'SecurityProfileArn' => [ 'shape' => 'ARN', ], ], ], 'CreateTaskTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', 'Fields', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Constraints' => [ 'shape' => 'TaskTemplateConstraints', ], 'Defaults' => [ 'shape' => 'TaskTemplateDefaults', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'Fields' => [ 'shape' => 'TaskTemplateFields', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateTaskTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'Id', 'Arn', ], 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateId', ], 'Arn' => [ 'shape' => 'TaskTemplateArn', ], ], ], 'CreateTrafficDistributionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'InstanceId', ], 'members' => [ 'Name' => [ 'shape' => 'Name128', ], 'Description' => [ 'shape' => 'Description250', ], 'InstanceId' => [ 'shape' => 'InstanceIdOrArn', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateTrafficDistributionGroupResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupId', ], 'Arn' => [ 'shape' => 'TrafficDistributionGroupArn', ], ], ], 'CreateUseCaseRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationAssociationId', 'UseCaseType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', 'location' => 'uri', 'locationName' => 'IntegrationAssociationId', ], 'UseCaseType' => [ 'shape' => 'UseCaseType', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateUseCaseResponse' => [ 'type' => 'structure', 'members' => [ 'UseCaseId' => [ 'shape' => 'UseCaseId', ], 'UseCaseArn' => [ 'shape' => 'ARN', ], ], ], 'CreateUserHierarchyGroupRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'InstanceId', ], 'members' => [ 'Name' => [ 'shape' => 'HierarchyGroupName', ], 'ParentGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateUserHierarchyGroupResponse' => [ 'type' => 'structure', 'members' => [ 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'HierarchyGroupArn' => [ 'shape' => 'ARN', ], ], ], 'CreateUserRequest' => [ 'type' => 'structure', 'required' => [ 'Username', 'PhoneConfig', 'SecurityProfileIds', 'RoutingProfileId', 'InstanceId', ], 'members' => [ 'Username' => [ 'shape' => 'AgentUsername', ], 'Password' => [ 'shape' => 'Password', ], 'IdentityInfo' => [ 'shape' => 'UserIdentityInfo', ], 'PhoneConfig' => [ 'shape' => 'UserPhoneConfig', ], 'DirectoryUserId' => [ 'shape' => 'DirectoryUserId', ], 'SecurityProfileIds' => [ 'shape' => 'SecurityProfileIds', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateUserResponse' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], 'UserArn' => [ 'shape' => 'ARN', ], ], ], 'CreateViewRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Status', 'Content', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ClientToken' => [ 'shape' => 'ViewsClientToken', ], 'Status' => [ 'shape' => 'ViewStatus', ], 'Content' => [ 'shape' => 'ViewInputContent', ], 'Description' => [ 'shape' => 'ViewDescription', ], 'Name' => [ 'shape' => 'ViewName', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateViewResponse' => [ 'type' => 'structure', 'members' => [ 'View' => [ 'shape' => 'View', ], ], ], 'CreateViewVersionRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'VersionDescription' => [ 'shape' => 'ViewDescription', ], 'ViewContentSha256' => [ 'shape' => 'ViewContentSha256', ], ], ], 'CreateViewVersionResponse' => [ 'type' => 'structure', 'members' => [ 'View' => [ 'shape' => 'View', ], ], ], 'CreateVocabularyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'VocabularyName', 'LanguageCode', 'Content', ], 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'VocabularyName' => [ 'shape' => 'VocabularyName', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'Content' => [ 'shape' => 'VocabularyContent', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateVocabularyResponse' => [ 'type' => 'structure', 'required' => [ 'VocabularyArn', 'VocabularyId', 'State', ], 'members' => [ 'VocabularyArn' => [ 'shape' => 'ARN', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', ], 'State' => [ 'shape' => 'VocabularyState', ], ], ], 'CreatedByInfo' => [ 'type' => 'structure', 'members' => [ 'ConnectUserArn' => [ 'shape' => 'ARN', ], 'AWSIdentityArn' => [ 'shape' => 'ARN', ], ], 'union' => true, ], 'Credentials' => [ 'type' => 'structure', 'members' => [ 'AccessToken' => [ 'shape' => 'SecurityToken', ], 'AccessTokenExpiration' => [ 'shape' => 'timestamp', ], 'RefreshToken' => [ 'shape' => 'SecurityToken', ], 'RefreshTokenExpiration' => [ 'shape' => 'timestamp', ], ], 'sensitive' => true, ], 'CrossChannelBehavior' => [ 'type' => 'structure', 'required' => [ 'BehaviorType', ], 'members' => [ 'BehaviorType' => [ 'shape' => 'BehaviorType', ], ], ], 'CurrentMetric' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'CurrentMetricName', ], 'Unit' => [ 'shape' => 'Unit', ], ], ], 'CurrentMetricData' => [ 'type' => 'structure', 'members' => [ 'Metric' => [ 'shape' => 'CurrentMetric', ], 'Value' => [ 'shape' => 'Value', 'box' => true, ], ], ], 'CurrentMetricDataCollections' => [ 'type' => 'list', 'member' => [ 'shape' => 'CurrentMetricData', ], ], 'CurrentMetricName' => [ 'type' => 'string', 'enum' => [ 'AGENTS_ONLINE', 'AGENTS_AVAILABLE', 'AGENTS_ON_CALL', 'AGENTS_NON_PRODUCTIVE', 'AGENTS_AFTER_CONTACT_WORK', 'AGENTS_ERROR', 'AGENTS_STAFFED', 'CONTACTS_IN_QUEUE', 'OLDEST_CONTACT_AGE', 'CONTACTS_SCHEDULED', 'AGENTS_ON_CONTACT', 'SLOTS_ACTIVE', 'SLOTS_AVAILABLE', ], ], 'CurrentMetricResult' => [ 'type' => 'structure', 'members' => [ 'Dimensions' => [ 'shape' => 'Dimensions', ], 'Collections' => [ 'shape' => 'CurrentMetricDataCollections', ], ], ], 'CurrentMetricResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'CurrentMetricResult', ], ], 'CurrentMetricSortCriteria' => [ 'type' => 'structure', 'members' => [ 'SortByMetric' => [ 'shape' => 'CurrentMetricName', ], 'SortOrder' => [ 'shape' => 'SortOrder', ], ], ], 'CurrentMetricSortCriteriaMaxOne' => [ 'type' => 'list', 'member' => [ 'shape' => 'CurrentMetricSortCriteria', ], 'max' => 1, 'min' => 0, ], 'CurrentMetrics' => [ 'type' => 'list', 'member' => [ 'shape' => 'CurrentMetric', ], ], 'Customer' => [ 'type' => 'structure', 'members' => [ 'DeviceInfo' => [ 'shape' => 'DeviceInfo', ], 'Capabilities' => [ 'shape' => 'ParticipantCapabilities', ], ], ], 'CustomerQualityMetrics' => [ 'type' => 'structure', 'members' => [ 'Audio' => [ 'shape' => 'AudioQualityMetricsInfo', ], ], ], 'CustomerVoiceActivity' => [ 'type' => 'structure', 'members' => [ 'GreetingStartTimestamp' => [ 'shape' => 'timestamp', ], 'GreetingEndTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'DataSetId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'DataSetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSetId', ], ], 'DateReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'DeactivateEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', 'EvaluationFormVersion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'DeactivateEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', 'EvaluationFormVersion', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'DefaultVocabulary' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'LanguageCode', 'VocabularyId', 'VocabularyName', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', ], 'VocabularyName' => [ 'shape' => 'VocabularyName', ], ], ], 'DefaultVocabularyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DefaultVocabulary', ], ], 'Delay' => [ 'type' => 'integer', 'max' => 9999, 'min' => 0, ], 'DeleteAttachedFileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FileId', 'AssociatedResourceArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FileId' => [ 'shape' => 'FileId', 'location' => 'uri', 'locationName' => 'FileId', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], ], ], 'DeleteAttachedFileResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationId', ], ], ], 'DeleteContactFlowModuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowModuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowModuleId' => [ 'shape' => 'ContactFlowModuleId', 'location' => 'uri', 'locationName' => 'ContactFlowModuleId', ], ], ], 'DeleteContactFlowModuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], ], ], 'DeleteContactFlowResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', 'box' => true, 'location' => 'querystring', 'locationName' => 'version', ], ], ], 'DeleteHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', 'location' => 'uri', 'locationName' => 'HoursOfOperationId', ], ], ], 'DeleteInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DeleteIntegrationAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationAssociationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', 'location' => 'uri', 'locationName' => 'IntegrationAssociationId', ], ], ], 'DeletePredefinedAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'PredefinedAttributeName', 'location' => 'uri', 'locationName' => 'Name', ], ], ], 'DeletePromptRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'PromptId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PromptId' => [ 'shape' => 'PromptId', 'location' => 'uri', 'locationName' => 'PromptId', ], ], ], 'DeleteQueueRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], ], ], 'DeleteQuickConnectRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QuickConnectId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', 'location' => 'uri', 'locationName' => 'QuickConnectId', ], ], ], 'DeleteRoutingProfileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], ], ], 'DeleteRuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RuleId' => [ 'shape' => 'RuleId', 'location' => 'uri', 'locationName' => 'RuleId', ], ], ], 'DeleteSecurityProfileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'SecurityProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], ], ], 'DeleteTaskTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'TaskTemplateId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'TaskTemplateId' => [ 'shape' => 'TaskTemplateId', 'location' => 'uri', 'locationName' => 'TaskTemplateId', ], ], ], 'DeleteTaskTemplateResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTrafficDistributionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], ], ], 'DeleteTrafficDistributionGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUseCaseRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationAssociationId', 'UseCaseId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', 'location' => 'uri', 'locationName' => 'IntegrationAssociationId', ], 'UseCaseId' => [ 'shape' => 'UseCaseId', 'location' => 'uri', 'locationName' => 'UseCaseId', ], ], ], 'DeleteUserHierarchyGroupRequest' => [ 'type' => 'structure', 'required' => [ 'HierarchyGroupId', 'InstanceId', ], 'members' => [ 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', 'location' => 'uri', 'locationName' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], ], ], 'DeleteViewRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], ], ], 'DeleteViewResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteViewVersionRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', 'ViewVersion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'ViewVersion' => [ 'shape' => 'ViewVersion', 'location' => 'uri', 'locationName' => 'ViewVersion', ], ], ], 'DeleteViewVersionResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteVocabularyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'VocabularyId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', 'location' => 'uri', 'locationName' => 'VocabularyId', ], ], ], 'DeleteVocabularyResponse' => [ 'type' => 'structure', 'required' => [ 'VocabularyArn', 'VocabularyId', 'State', ], 'members' => [ 'VocabularyArn' => [ 'shape' => 'ARN', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', ], 'State' => [ 'shape' => 'VocabularyState', ], ], ], 'DescribeAgentStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AgentStatusId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', 'location' => 'uri', 'locationName' => 'AgentStatusId', ], ], ], 'DescribeAgentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'AgentStatus' => [ 'shape' => 'AgentStatus', ], ], ], 'DescribeContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationId', ], ], ], 'DescribeContactEvaluationResponse' => [ 'type' => 'structure', 'required' => [ 'Evaluation', 'EvaluationForm', ], 'members' => [ 'Evaluation' => [ 'shape' => 'Evaluation', ], 'EvaluationForm' => [ 'shape' => 'EvaluationFormContent', ], ], ], 'DescribeContactFlowModuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowModuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowModuleId' => [ 'shape' => 'ContactFlowModuleId', 'location' => 'uri', 'locationName' => 'ContactFlowModuleId', ], ], ], 'DescribeContactFlowModuleResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowModule' => [ 'shape' => 'ContactFlowModule', ], ], ], 'DescribeContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], ], ], 'DescribeContactFlowResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlow' => [ 'shape' => 'ContactFlow', ], ], ], 'DescribeContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], ], ], 'DescribeContactResponse' => [ 'type' => 'structure', 'members' => [ 'Contact' => [ 'shape' => 'Contact', ], ], ], 'DescribeEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', 'box' => true, 'location' => 'querystring', 'locationName' => 'version', ], ], ], 'DescribeEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationForm', ], 'members' => [ 'EvaluationForm' => [ 'shape' => 'EvaluationForm', ], ], ], 'DescribeHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', 'location' => 'uri', 'locationName' => 'HoursOfOperationId', ], ], ], 'DescribeHoursOfOperationResponse' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperation' => [ 'shape' => 'HoursOfOperation', ], ], ], 'DescribeInstanceAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AttributeType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AttributeType' => [ 'shape' => 'InstanceAttributeType', 'location' => 'uri', 'locationName' => 'AttributeType', ], ], ], 'DescribeInstanceAttributeResponse' => [ 'type' => 'structure', 'members' => [ 'Attribute' => [ 'shape' => 'Attribute', ], ], ], 'DescribeInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'Instance' => [ 'shape' => 'Instance', ], ], ], 'DescribeInstanceStorageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AssociationId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociationId' => [ 'shape' => 'AssociationId', 'location' => 'uri', 'locationName' => 'AssociationId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', 'location' => 'querystring', 'locationName' => 'resourceType', ], ], ], 'DescribeInstanceStorageConfigResponse' => [ 'type' => 'structure', 'members' => [ 'StorageConfig' => [ 'shape' => 'InstanceStorageConfig', ], ], ], 'DescribePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], ], ], 'DescribePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'ClaimedPhoneNumberSummary' => [ 'shape' => 'ClaimedPhoneNumberSummary', ], ], ], 'DescribePredefinedAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'PredefinedAttributeName', 'location' => 'uri', 'locationName' => 'Name', ], ], ], 'DescribePredefinedAttributeResponse' => [ 'type' => 'structure', 'members' => [ 'PredefinedAttribute' => [ 'shape' => 'PredefinedAttribute', ], ], ], 'DescribePromptRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'PromptId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PromptId' => [ 'shape' => 'PromptId', 'location' => 'uri', 'locationName' => 'PromptId', ], ], ], 'DescribePromptResponse' => [ 'type' => 'structure', 'members' => [ 'Prompt' => [ 'shape' => 'Prompt', ], ], ], 'DescribeQueueRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], ], ], 'DescribeQueueResponse' => [ 'type' => 'structure', 'members' => [ 'Queue' => [ 'shape' => 'Queue', ], ], ], 'DescribeQuickConnectRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QuickConnectId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', 'location' => 'uri', 'locationName' => 'QuickConnectId', ], ], ], 'DescribeQuickConnectResponse' => [ 'type' => 'structure', 'members' => [ 'QuickConnect' => [ 'shape' => 'QuickConnect', ], ], ], 'DescribeRoutingProfileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], ], ], 'DescribeRoutingProfileResponse' => [ 'type' => 'structure', 'members' => [ 'RoutingProfile' => [ 'shape' => 'RoutingProfile', ], ], ], 'DescribeRuleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RuleId' => [ 'shape' => 'RuleId', 'location' => 'uri', 'locationName' => 'RuleId', ], ], ], 'DescribeRuleResponse' => [ 'type' => 'structure', 'required' => [ 'Rule', ], 'members' => [ 'Rule' => [ 'shape' => 'Rule', ], ], ], 'DescribeSecurityProfileRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileId', 'InstanceId', ], 'members' => [ 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeSecurityProfileResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityProfile' => [ 'shape' => 'SecurityProfile', ], ], ], 'DescribeTrafficDistributionGroupRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], ], ], 'DescribeTrafficDistributionGroupResponse' => [ 'type' => 'structure', 'members' => [ 'TrafficDistributionGroup' => [ 'shape' => 'TrafficDistributionGroup', ], ], ], 'DescribeUserHierarchyGroupRequest' => [ 'type' => 'structure', 'required' => [ 'HierarchyGroupId', 'InstanceId', ], 'members' => [ 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', 'location' => 'uri', 'locationName' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeUserHierarchyGroupResponse' => [ 'type' => 'structure', 'members' => [ 'HierarchyGroup' => [ 'shape' => 'HierarchyGroup', ], ], ], 'DescribeUserHierarchyStructureRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeUserHierarchyStructureResponse' => [ 'type' => 'structure', 'members' => [ 'HierarchyStructure' => [ 'shape' => 'HierarchyStructure', ], ], ], 'DescribeUserRequest' => [ 'type' => 'structure', 'required' => [ 'UserId', 'InstanceId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'DescribeUserResponse' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'User', ], ], ], 'DescribeViewRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], ], ], 'DescribeViewResponse' => [ 'type' => 'structure', 'members' => [ 'View' => [ 'shape' => 'View', ], ], ], 'DescribeVocabularyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'VocabularyId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'VocabularyId' => [ 'shape' => 'VocabularyId', 'location' => 'uri', 'locationName' => 'VocabularyId', ], ], ], 'DescribeVocabularyResponse' => [ 'type' => 'structure', 'required' => [ 'Vocabulary', ], 'members' => [ 'Vocabulary' => [ 'shape' => 'Vocabulary', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, 'sensitive' => true, ], 'Description250' => [ 'type' => 'string', 'max' => 250, 'min' => 1, 'pattern' => '(^[\\S].*[\\S]$)|(^[\\S]$)', ], 'DestinationId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'DestinationNotAllowedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'DeviceInfo' => [ 'type' => 'structure', 'members' => [ 'PlatformName' => [ 'shape' => 'PlatformName', ], 'PlatformVersion' => [ 'shape' => 'PlatformVersion', ], 'OperatingSystem' => [ 'shape' => 'OperatingSystem', ], ], ], 'Dimensions' => [ 'type' => 'structure', 'members' => [ 'Queue' => [ 'shape' => 'QueueReference', ], 'Channel' => [ 'shape' => 'Channel', ], 'RoutingProfile' => [ 'shape' => 'RoutingProfileReference', ], 'RoutingStepExpression' => [ 'shape' => 'RoutingExpression', ], ], ], 'DimensionsV2Key' => [ 'type' => 'string', ], 'DimensionsV2Map' => [ 'type' => 'map', 'key' => [ 'shape' => 'DimensionsV2Key', ], 'value' => [ 'shape' => 'DimensionsV2Value', ], ], 'DimensionsV2Value' => [ 'type' => 'string', ], 'DirectoryAlias' => [ 'type' => 'string', 'max' => 45, 'min' => 1, 'pattern' => '^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$', 'sensitive' => true, ], 'DirectoryId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^d-[0-9a-f]{10}$', ], 'DirectoryType' => [ 'type' => 'string', 'enum' => [ 'SAML', 'CONNECT_MANAGED', 'EXISTING_DIRECTORY', ], ], 'DirectoryUserId' => [ 'type' => 'string', ], 'DisassociateAnalyticsDataSetRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'DataSetId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetId' => [ 'shape' => 'DataSetId', ], 'TargetAccountId' => [ 'shape' => 'AWSAccountId', ], ], ], 'DisassociateApprovedOriginRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Origin', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Origin' => [ 'shape' => 'Origin', 'location' => 'querystring', 'locationName' => 'origin', ], ], ], 'DisassociateBotRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LexBot' => [ 'shape' => 'LexBot', ], 'LexV2Bot' => [ 'shape' => 'LexV2Bot', ], ], ], 'DisassociateFlowRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceId' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'FlowAssociationResourceType', 'location' => 'uri', 'locationName' => 'ResourceType', ], ], ], 'DisassociateFlowResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateInstanceStorageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AssociationId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociationId' => [ 'shape' => 'AssociationId', 'location' => 'uri', 'locationName' => 'AssociationId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', 'location' => 'querystring', 'locationName' => 'resourceType', ], ], ], 'DisassociateLambdaFunctionRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FunctionArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FunctionArn' => [ 'shape' => 'FunctionArn', 'location' => 'querystring', 'locationName' => 'functionArn', ], ], ], 'DisassociateLexBotRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'BotName', 'LexRegion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'BotName' => [ 'shape' => 'BotName', 'location' => 'querystring', 'locationName' => 'botName', ], 'LexRegion' => [ 'shape' => 'LexRegion', 'location' => 'querystring', 'locationName' => 'lexRegion', ], ], ], 'DisassociatePhoneNumberContactFlowRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', 'InstanceId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'querystring', 'locationName' => 'instanceId', ], ], ], 'DisassociateQueueQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'QuickConnectIds', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'QuickConnectIds' => [ 'shape' => 'QuickConnectsList', ], ], ], 'DisassociateRoutingProfileQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'QueueReferences', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'QueueReferences' => [ 'shape' => 'RoutingProfileQueueReferenceList', ], ], ], 'DisassociateSecurityKeyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AssociationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociationId' => [ 'shape' => 'AssociationId', 'location' => 'uri', 'locationName' => 'AssociationId', ], ], ], 'DisassociateTrafficDistributionGroupUserRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', 'UserId', 'InstanceId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'querystring', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'querystring', 'locationName' => 'InstanceId', ], ], ], 'DisassociateTrafficDistributionGroupUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateUserProficienciesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', 'UserProficiencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'UserProficiencies' => [ 'shape' => 'UserProficiencyDisassociateList', ], ], ], 'DisconnectDetails' => [ 'type' => 'structure', 'members' => [ 'PotentialDisconnectIssue' => [ 'shape' => 'PotentialDisconnectIssue', ], ], ], 'DisconnectReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'DisconnectReasonCode', ], ], ], 'DisconnectReasonCode' => [ 'type' => 'string', ], 'DismissUserContactRequest' => [ 'type' => 'structure', 'required' => [ 'UserId', 'InstanceId', 'ContactId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], ], ], 'DismissUserContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisplayName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Distribution' => [ 'type' => 'structure', 'required' => [ 'Region', 'Percentage', ], 'members' => [ 'Region' => [ 'shape' => 'AwsRegion', ], 'Percentage' => [ 'shape' => 'Percentage', ], ], ], 'DistributionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Distribution', ], ], 'Double' => [ 'type' => 'double', ], 'DownloadUrlMetadata' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'MetadataUrl', ], 'UrlExpiry' => [ 'shape' => 'ISO8601Datetime', ], ], ], 'DuplicateResourceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'DurationInSeconds' => [ 'type' => 'integer', ], 'Email' => [ 'type' => 'string', 'sensitive' => true, ], 'EmailReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'EmptyFieldValue' => [ 'type' => 'structure', 'members' => [], ], 'EncryptionConfig' => [ 'type' => 'structure', 'required' => [ 'EncryptionType', 'KeyId', ], 'members' => [ 'EncryptionType' => [ 'shape' => 'EncryptionType', ], 'KeyId' => [ 'shape' => 'KeyId', ], ], ], 'EncryptionType' => [ 'type' => 'string', 'enum' => [ 'KMS', ], ], 'EndAssociatedTasksActionDefinition' => [ 'type' => 'structure', 'members' => [], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'EndpointType', ], 'Address' => [ 'shape' => 'EndpointAddress', ], ], ], 'EndpointAddress' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'EndpointType' => [ 'type' => 'string', 'enum' => [ 'TELEPHONE_NUMBER', 'VOIP', 'CONTACT_FLOW', ], ], 'ErrorCode' => [ 'type' => 'string', ], 'ErrorMessage' => [ 'type' => 'string', ], 'ErrorResult' => [ 'type' => 'structure', 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'ErrorResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'ErrorResult', ], ], 'Evaluation' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', 'Metadata', 'Answers', 'Notes', 'Status', 'CreatedTime', 'LastModifiedTime', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], 'Metadata' => [ 'shape' => 'EvaluationMetadata', ], 'Answers' => [ 'shape' => 'EvaluationAnswersOutputMap', ], 'Notes' => [ 'shape' => 'EvaluationNotesMap', ], 'Status' => [ 'shape' => 'EvaluationStatus', ], 'Scores' => [ 'shape' => 'EvaluationScoresMap', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'EvaluationAnswerData' => [ 'type' => 'structure', 'members' => [ 'StringValue' => [ 'shape' => 'EvaluationAnswerDataStringValue', ], 'NumericValue' => [ 'shape' => 'EvaluationAnswerDataNumericValue', ], 'NotApplicable' => [ 'shape' => 'Boolean', ], ], 'union' => true, ], 'EvaluationAnswerDataNumericValue' => [ 'type' => 'double', ], 'EvaluationAnswerDataStringValue' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'EvaluationAnswerInput' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'EvaluationAnswerData', ], ], ], 'EvaluationAnswerOutput' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'EvaluationAnswerData', ], 'SystemSuggestedValue' => [ 'shape' => 'EvaluationAnswerData', ], ], ], 'EvaluationAnswersInputMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceId', ], 'value' => [ 'shape' => 'EvaluationAnswerInput', ], 'max' => 100, ], 'EvaluationAnswersOutputMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceId', ], 'value' => [ 'shape' => 'EvaluationAnswerOutput', ], 'max' => 100, ], 'EvaluationForm' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormVersion', 'Locked', 'EvaluationFormArn', 'Title', 'Status', 'Items', 'CreatedTime', 'CreatedBy', 'LastModifiedTime', 'LastModifiedBy', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], 'Locked' => [ 'shape' => 'EvaluationFormVersionIsLocked', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'Description' => [ 'shape' => 'EvaluationFormDescription', ], 'Status' => [ 'shape' => 'EvaluationFormVersionStatus', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'ScoringStrategy' => [ 'shape' => 'EvaluationFormScoringStrategy', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'ARN', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'ARN', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'EvaluationFormContent' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormVersion', 'EvaluationFormId', 'EvaluationFormArn', 'Title', 'Items', ], 'members' => [ 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'Description' => [ 'shape' => 'EvaluationFormDescription', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'ScoringStrategy' => [ 'shape' => 'EvaluationFormScoringStrategy', ], ], ], 'EvaluationFormDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'EvaluationFormId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'EvaluationFormItem' => [ 'type' => 'structure', 'members' => [ 'Section' => [ 'shape' => 'EvaluationFormSection', ], 'Question' => [ 'shape' => 'EvaluationFormQuestion', ], ], 'union' => true, ], 'EvaluationFormItemWeight' => [ 'type' => 'double', 'max' => 100, 'min' => 0, ], 'EvaluationFormItemsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormItem', ], 'max' => 100, 'min' => 1, ], 'EvaluationFormNumericQuestionAutomation' => [ 'type' => 'structure', 'members' => [ 'PropertyValue' => [ 'shape' => 'NumericQuestionPropertyValueAutomation', ], ], 'union' => true, ], 'EvaluationFormNumericQuestionOption' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'Integer', ], 'MaxValue' => [ 'shape' => 'Integer', ], 'Score' => [ 'shape' => 'EvaluationFormQuestionAnswerScore', ], 'AutomaticFail' => [ 'shape' => 'Boolean', ], ], ], 'EvaluationFormNumericQuestionOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormNumericQuestionOption', ], 'max' => 10, 'min' => 1, ], 'EvaluationFormNumericQuestionProperties' => [ 'type' => 'structure', 'required' => [ 'MinValue', 'MaxValue', ], 'members' => [ 'MinValue' => [ 'shape' => 'Integer', ], 'MaxValue' => [ 'shape' => 'Integer', ], 'Options' => [ 'shape' => 'EvaluationFormNumericQuestionOptionList', ], 'Automation' => [ 'shape' => 'EvaluationFormNumericQuestionAutomation', ], ], ], 'EvaluationFormQuestion' => [ 'type' => 'structure', 'required' => [ 'Title', 'RefId', 'QuestionType', ], 'members' => [ 'Title' => [ 'shape' => 'EvaluationFormQuestionTitle', ], 'Instructions' => [ 'shape' => 'EvaluationFormQuestionInstructions', ], 'RefId' => [ 'shape' => 'ReferenceId', ], 'NotApplicableEnabled' => [ 'shape' => 'Boolean', ], 'QuestionType' => [ 'shape' => 'EvaluationFormQuestionType', ], 'QuestionTypeProperties' => [ 'shape' => 'EvaluationFormQuestionTypeProperties', ], 'Weight' => [ 'shape' => 'EvaluationFormItemWeight', ], ], ], 'EvaluationFormQuestionAnswerScore' => [ 'type' => 'integer', 'max' => 10, 'min' => 0, ], 'EvaluationFormQuestionInstructions' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'EvaluationFormQuestionTitle' => [ 'type' => 'string', 'max' => 350, 'min' => 0, ], 'EvaluationFormQuestionType' => [ 'type' => 'string', 'enum' => [ 'TEXT', 'SINGLESELECT', 'NUMERIC', ], ], 'EvaluationFormQuestionTypeProperties' => [ 'type' => 'structure', 'members' => [ 'Numeric' => [ 'shape' => 'EvaluationFormNumericQuestionProperties', ], 'SingleSelect' => [ 'shape' => 'EvaluationFormSingleSelectQuestionProperties', ], ], 'union' => true, ], 'EvaluationFormScoringMode' => [ 'type' => 'string', 'enum' => [ 'QUESTION_ONLY', 'SECTION_ONLY', ], ], 'EvaluationFormScoringStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'EvaluationFormScoringStrategy' => [ 'type' => 'structure', 'required' => [ 'Mode', 'Status', ], 'members' => [ 'Mode' => [ 'shape' => 'EvaluationFormScoringMode', ], 'Status' => [ 'shape' => 'EvaluationFormScoringStatus', ], ], ], 'EvaluationFormSection' => [ 'type' => 'structure', 'required' => [ 'Title', 'RefId', 'Items', ], 'members' => [ 'Title' => [ 'shape' => 'EvaluationFormSectionTitle', ], 'RefId' => [ 'shape' => 'ReferenceId', ], 'Instructions' => [ 'shape' => 'EvaluationFormQuestionInstructions', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'Weight' => [ 'shape' => 'EvaluationFormItemWeight', ], ], ], 'EvaluationFormSectionTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'EvaluationFormSingleSelectQuestionAutomation' => [ 'type' => 'structure', 'required' => [ 'Options', ], 'members' => [ 'Options' => [ 'shape' => 'EvaluationFormSingleSelectQuestionAutomationOptionList', ], 'DefaultOptionRefId' => [ 'shape' => 'ReferenceId', ], ], ], 'EvaluationFormSingleSelectQuestionAutomationOption' => [ 'type' => 'structure', 'members' => [ 'RuleCategory' => [ 'shape' => 'SingleSelectQuestionRuleCategoryAutomation', ], ], 'union' => true, ], 'EvaluationFormSingleSelectQuestionAutomationOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormSingleSelectQuestionAutomationOption', ], 'max' => 20, 'min' => 1, ], 'EvaluationFormSingleSelectQuestionDisplayMode' => [ 'type' => 'string', 'enum' => [ 'DROPDOWN', 'RADIO', ], ], 'EvaluationFormSingleSelectQuestionOption' => [ 'type' => 'structure', 'required' => [ 'RefId', 'Text', ], 'members' => [ 'RefId' => [ 'shape' => 'ReferenceId', ], 'Text' => [ 'shape' => 'EvaluationFormSingleSelectQuestionOptionText', ], 'Score' => [ 'shape' => 'EvaluationFormQuestionAnswerScore', ], 'AutomaticFail' => [ 'shape' => 'Boolean', ], ], ], 'EvaluationFormSingleSelectQuestionOptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormSingleSelectQuestionOption', ], 'max' => 256, 'min' => 1, ], 'EvaluationFormSingleSelectQuestionOptionText' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'EvaluationFormSingleSelectQuestionProperties' => [ 'type' => 'structure', 'required' => [ 'Options', ], 'members' => [ 'Options' => [ 'shape' => 'EvaluationFormSingleSelectQuestionOptionList', ], 'DisplayAs' => [ 'shape' => 'EvaluationFormSingleSelectQuestionDisplayMode', ], 'Automation' => [ 'shape' => 'EvaluationFormSingleSelectQuestionAutomation', ], ], ], 'EvaluationFormSummary' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', 'Title', 'CreatedTime', 'CreatedBy', 'LastModifiedTime', 'LastModifiedBy', 'LatestVersion', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'ARN', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'ARN', ], 'LastActivatedTime' => [ 'shape' => 'Timestamp', ], 'LastActivatedBy' => [ 'shape' => 'ARN', ], 'LatestVersion' => [ 'shape' => 'VersionNumber', ], 'ActiveVersion' => [ 'shape' => 'VersionNumber', 'box' => true, ], ], ], 'EvaluationFormSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormSummary', ], ], 'EvaluationFormTitle' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'EvaluationFormVersionIsLocked' => [ 'type' => 'boolean', ], 'EvaluationFormVersionStatus' => [ 'type' => 'string', 'enum' => [ 'DRAFT', 'ACTIVE', ], ], 'EvaluationFormVersionSummary' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormArn', 'EvaluationFormId', 'EvaluationFormVersion', 'Locked', 'Status', 'CreatedTime', 'CreatedBy', 'LastModifiedTime', 'LastModifiedBy', ], 'members' => [ 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], 'Locked' => [ 'shape' => 'EvaluationFormVersionIsLocked', ], 'Status' => [ 'shape' => 'EvaluationFormVersionStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'CreatedBy' => [ 'shape' => 'ARN', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedBy' => [ 'shape' => 'ARN', ], ], ], 'EvaluationFormVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationFormVersionSummary', ], ], 'EvaluationMetadata' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'EvaluatorArn', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'EvaluatorArn' => [ 'shape' => 'ARN', ], 'ContactAgentId' => [ 'shape' => 'ResourceId', ], 'Score' => [ 'shape' => 'EvaluationScore', ], ], ], 'EvaluationNote' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'EvaluationNoteString', ], ], ], 'EvaluationNoteString' => [ 'type' => 'string', 'max' => 3072, 'min' => 0, ], 'EvaluationNotesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceId', ], 'value' => [ 'shape' => 'EvaluationNote', ], 'max' => 100, ], 'EvaluationScore' => [ 'type' => 'structure', 'members' => [ 'Percentage' => [ 'shape' => 'EvaluationScorePercentage', ], 'NotApplicable' => [ 'shape' => 'Boolean', ], 'AutomaticFail' => [ 'shape' => 'Boolean', ], ], ], 'EvaluationScorePercentage' => [ 'type' => 'double', 'max' => 100, 'min' => 0, ], 'EvaluationScoresMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ResourceId', ], 'value' => [ 'shape' => 'EvaluationScore', ], 'max' => 100, ], 'EvaluationStatus' => [ 'type' => 'string', 'enum' => [ 'DRAFT', 'SUBMITTED', ], ], 'EvaluationSummary' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', 'EvaluationFormTitle', 'EvaluationFormId', 'Status', 'EvaluatorArn', 'CreatedTime', 'LastModifiedTime', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], 'EvaluationFormTitle' => [ 'shape' => 'EvaluationFormTitle', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'Status' => [ 'shape' => 'EvaluationStatus', ], 'EvaluatorArn' => [ 'shape' => 'ARN', ], 'Score' => [ 'shape' => 'EvaluationScore', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'EvaluationSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EvaluationSummary', ], ], 'EventBridgeActionDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'EventBridgeActionName', ], ], ], 'EventBridgeActionName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'EventSourceName' => [ 'type' => 'string', 'enum' => [ 'OnPostCallAnalysisAvailable', 'OnRealTimeCallAnalysisAvailable', 'OnRealTimeChatAnalysisAvailable', 'OnPostChatAnalysisAvailable', 'OnZendeskTicketCreate', 'OnZendeskTicketStatusUpdate', 'OnSalesforceCaseCreate', 'OnContactEvaluationSubmit', 'OnMetricDataUpdate', 'OnCaseCreate', 'OnCaseUpdate', ], ], 'Expiry' => [ 'type' => 'structure', 'members' => [ 'DurationInSeconds' => [ 'shape' => 'DurationInSeconds', ], 'ExpiryTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'Expression' => [ 'type' => 'structure', 'members' => [ 'AttributeCondition' => [ 'shape' => 'AttributeCondition', ], 'AndExpression' => [ 'shape' => 'Expressions', ], 'OrExpression' => [ 'shape' => 'Expressions', ], ], ], 'Expressions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Expression', ], ], 'FailedRequest' => [ 'type' => 'structure', 'members' => [ 'RequestIdentifier' => [ 'shape' => 'RequestIdentifier', ], 'FailureReasonCode' => [ 'shape' => 'FailureReasonCode', ], 'FailureReasonMessage' => [ 'shape' => 'String', ], ], ], 'FailedRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FailedRequest', ], ], 'FailureReasonCode' => [ 'type' => 'string', 'enum' => [ 'INVALID_ATTRIBUTE_KEY', 'INVALID_CUSTOMER_ENDPOINT', 'INVALID_SYSTEM_ENDPOINT', 'INVALID_QUEUE', 'MISSING_CAMPAIGN', 'MISSING_CUSTOMER_ENDPOINT', 'MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT', 'REQUEST_THROTTLED', 'IDEMPOTENCY_EXCEPTION', 'INTERNAL_ERROR', ], ], 'FieldStringValue' => [ 'type' => 'string', 'max' => 500, 'min' => 0, ], 'FieldValue' => [ 'type' => 'structure', 'required' => [ 'Id', 'Value', ], 'members' => [ 'Id' => [ 'shape' => 'FieldValueId', ], 'Value' => [ 'shape' => 'FieldValueUnion', ], ], ], 'FieldValueId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'FieldValueUnion' => [ 'type' => 'structure', 'members' => [ 'BooleanValue' => [ 'shape' => 'Boolean', ], 'DoubleValue' => [ 'shape' => 'Double', ], 'EmptyValue' => [ 'shape' => 'EmptyFieldValue', ], 'StringValue' => [ 'shape' => 'FieldStringValue', ], ], ], 'FieldValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FieldValue', ], ], 'FileId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'FileIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FileId', ], 'min' => 1, ], 'FileName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^\\P{C}*$', ], 'FileSizeInBytes' => [ 'type' => 'long', 'box' => true, 'min' => 1, ], 'FileStatusType' => [ 'type' => 'string', 'enum' => [ 'APPROVED', 'REJECTED', 'PROCESSING', 'FAILED', ], ], 'FileUseCaseType' => [ 'type' => 'string', 'enum' => [ 'ATTACHMENT', ], ], 'FilterV2' => [ 'type' => 'structure', 'members' => [ 'FilterKey' => [ 'shape' => 'ResourceArnOrId', ], 'FilterValues' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceArnOrId', ], 'max' => 100, 'min' => 1, ], 'Filters' => [ 'type' => 'structure', 'members' => [ 'Queues' => [ 'shape' => 'Queues', ], 'Channels' => [ 'shape' => 'Channels', ], 'RoutingProfiles' => [ 'shape' => 'RoutingProfiles', ], 'RoutingStepExpressions' => [ 'shape' => 'RoutingExpressions', ], ], ], 'FiltersV2List' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterV2', ], 'max' => 5, 'min' => 1, ], 'FlowAssociationResourceType' => [ 'type' => 'string', 'enum' => [ 'SMS_PHONE_NUMBER', ], ], 'FlowAssociationSummary' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ARN', ], 'FlowId' => [ 'shape' => 'ARN', ], 'ResourceType' => [ 'shape' => 'ListFlowAssociationResourceType', ], ], ], 'FlowAssociationSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FlowAssociationSummary', ], ], 'FunctionArn' => [ 'type' => 'string', 'max' => 140, 'min' => 1, ], 'FunctionArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FunctionArn', ], ], 'GetAttachedFileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FileId', 'AssociatedResourceArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FileId' => [ 'shape' => 'FileId', 'location' => 'uri', 'locationName' => 'FileId', ], 'UrlExpiryInSeconds' => [ 'shape' => 'URLExpiryInSeconds', 'location' => 'querystring', 'locationName' => 'urlExpiryInSeconds', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], ], ], 'GetAttachedFileResponse' => [ 'type' => 'structure', 'required' => [ 'FileSizeInBytes', ], 'members' => [ 'FileArn' => [ 'shape' => 'ARN', ], 'FileId' => [ 'shape' => 'FileId', ], 'CreationTime' => [ 'shape' => 'ISO8601Datetime', ], 'FileStatus' => [ 'shape' => 'FileStatusType', ], 'FileName' => [ 'shape' => 'FileName', ], 'FileSizeInBytes' => [ 'shape' => 'FileSizeInBytes', 'box' => true, ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', ], 'FileUseCaseType' => [ 'shape' => 'FileUseCaseType', ], 'CreatedBy' => [ 'shape' => 'CreatedByInfo', ], 'DownloadUrlMetadata' => [ 'shape' => 'DownloadUrlMetadata', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'GetContactAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'InitialContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'InitialContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'InitialContactId', ], ], ], 'GetContactAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'Attributes' => [ 'shape' => 'Attributes', ], ], ], 'GetCurrentMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Filters', 'CurrentMetrics', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Filters' => [ 'shape' => 'Filters', ], 'Groupings' => [ 'shape' => 'Groupings', ], 'CurrentMetrics' => [ 'shape' => 'CurrentMetrics', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SortCriteria' => [ 'shape' => 'CurrentMetricSortCriteriaMaxOne', ], ], ], 'GetCurrentMetricDataResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MetricResults' => [ 'shape' => 'CurrentMetricResults', ], 'DataSnapshotTime' => [ 'shape' => 'timestamp', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'GetCurrentUserDataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Filters', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Filters' => [ 'shape' => 'UserDataFilters', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], ], ], 'GetCurrentUserDataResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'UserDataList' => [ 'shape' => 'UserDataList', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'GetFederationTokenRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'GetFederationTokenResponse' => [ 'type' => 'structure', 'members' => [ 'Credentials' => [ 'shape' => 'Credentials', ], 'SignInUrl' => [ 'shape' => 'Url', ], 'UserArn' => [ 'shape' => 'ARN', ], 'UserId' => [ 'shape' => 'AgentResourceId', ], ], ], 'GetFlowAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceId' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'ResourceId', ], 'ResourceType' => [ 'shape' => 'FlowAssociationResourceType', 'location' => 'uri', 'locationName' => 'ResourceType', ], ], ], 'GetFlowAssociationResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ARN', ], 'FlowId' => [ 'shape' => 'ARN', ], 'ResourceType' => [ 'shape' => 'FlowAssociationResourceType', ], ], ], 'GetMetricDataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'StartTime', 'EndTime', 'Filters', 'HistoricalMetrics', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'StartTime' => [ 'shape' => 'timestamp', ], 'EndTime' => [ 'shape' => 'timestamp', ], 'Filters' => [ 'shape' => 'Filters', ], 'Groupings' => [ 'shape' => 'Groupings', ], 'HistoricalMetrics' => [ 'shape' => 'HistoricalMetrics', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], ], ], 'GetMetricDataResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MetricResults' => [ 'shape' => 'HistoricalMetricResults', ], ], ], 'GetMetricDataV2Request' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'StartTime', 'EndTime', 'Filters', 'Metrics', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ARN', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'Interval' => [ 'shape' => 'IntervalDetails', ], 'Filters' => [ 'shape' => 'FiltersV2List', ], 'Groupings' => [ 'shape' => 'GroupingsV2', ], 'Metrics' => [ 'shape' => 'MetricsV2', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], ], ], 'GetMetricDataV2Response' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MetricResults' => [ 'shape' => 'MetricResultsV2', ], ], ], 'GetPromptFileRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'PromptId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PromptId' => [ 'shape' => 'PromptId', 'location' => 'uri', 'locationName' => 'PromptId', ], ], ], 'GetPromptFileResponse' => [ 'type' => 'structure', 'members' => [ 'PromptPresignedUrl' => [ 'shape' => 'PromptPresignedUrl', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'GetTaskTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'TaskTemplateId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'TaskTemplateId' => [ 'shape' => 'TaskTemplateId', 'location' => 'uri', 'locationName' => 'TaskTemplateId', ], 'SnapshotVersion' => [ 'shape' => 'SnapshotVersion', 'location' => 'querystring', 'locationName' => 'snapshotVersion', ], ], ], 'GetTaskTemplateResponse' => [ 'type' => 'structure', 'required' => [ 'Id', 'Arn', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Id' => [ 'shape' => 'TaskTemplateId', ], 'Arn' => [ 'shape' => 'TaskTemplateArn', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Constraints' => [ 'shape' => 'TaskTemplateConstraints', ], 'Defaults' => [ 'shape' => 'TaskTemplateDefaults', ], 'Fields' => [ 'shape' => 'TaskTemplateFields', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'LastModifiedTime' => [ 'shape' => 'timestamp', ], 'CreatedTime' => [ 'shape' => 'timestamp', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'GetTrafficDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'Id', ], ], ], 'GetTrafficDistributionResponse' => [ 'type' => 'structure', 'members' => [ 'TelephonyConfig' => [ 'shape' => 'TelephonyConfig', ], 'Id' => [ 'shape' => 'TrafficDistributionGroupId', ], 'Arn' => [ 'shape' => 'TrafficDistributionGroupArn', ], 'SignInConfig' => [ 'shape' => 'SignInConfig', ], 'AgentConfig' => [ 'shape' => 'AgentConfig', ], ], ], 'Grouping' => [ 'type' => 'string', 'enum' => [ 'QUEUE', 'CHANNEL', 'ROUTING_PROFILE', 'ROUTING_STEP_EXPRESSION', ], ], 'GroupingV2' => [ 'type' => 'string', ], 'Groupings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Grouping', ], 'max' => 2, ], 'GroupingsV2' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupingV2', ], 'max' => 3, ], 'HierarchyGroup' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HierarchyGroupId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'HierarchyGroupName', ], 'LevelId' => [ 'shape' => 'HierarchyLevelId', ], 'HierarchyPath' => [ 'shape' => 'HierarchyPath', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HierarchyGroupCondition' => [ 'type' => 'structure', 'members' => [ 'Value' => [ 'shape' => 'String', ], 'HierarchyGroupMatchType' => [ 'shape' => 'HierarchyGroupMatchType', ], ], ], 'HierarchyGroupId' => [ 'type' => 'string', ], 'HierarchyGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HierarchyGroupId', ], 'max' => 10, 'min' => 0, ], 'HierarchyGroupMatchType' => [ 'type' => 'string', 'enum' => [ 'EXACT', 'WITH_CHILD_GROUPS', ], ], 'HierarchyGroupName' => [ 'type' => 'string', ], 'HierarchyGroupSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HierarchyGroupId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'HierarchyGroupName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HierarchyGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HierarchyGroupSummary', ], ], 'HierarchyGroupSummaryReference' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HierarchyGroupId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'HierarchyGroups' => [ 'type' => 'structure', 'members' => [ 'Level1' => [ 'shape' => 'AgentHierarchyGroup', ], 'Level2' => [ 'shape' => 'AgentHierarchyGroup', ], 'Level3' => [ 'shape' => 'AgentHierarchyGroup', ], 'Level4' => [ 'shape' => 'AgentHierarchyGroup', ], 'Level5' => [ 'shape' => 'AgentHierarchyGroup', ], ], ], 'HierarchyLevel' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HierarchyLevelId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'HierarchyLevelName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HierarchyLevelId' => [ 'type' => 'string', ], 'HierarchyLevelName' => [ 'type' => 'string', ], 'HierarchyLevelUpdate' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'HierarchyLevelName', ], ], ], 'HierarchyPath' => [ 'type' => 'structure', 'members' => [ 'LevelOne' => [ 'shape' => 'HierarchyGroupSummary', ], 'LevelTwo' => [ 'shape' => 'HierarchyGroupSummary', ], 'LevelThree' => [ 'shape' => 'HierarchyGroupSummary', ], 'LevelFour' => [ 'shape' => 'HierarchyGroupSummary', ], 'LevelFive' => [ 'shape' => 'HierarchyGroupSummary', ], ], ], 'HierarchyPathReference' => [ 'type' => 'structure', 'members' => [ 'LevelOne' => [ 'shape' => 'HierarchyGroupSummaryReference', ], 'LevelTwo' => [ 'shape' => 'HierarchyGroupSummaryReference', ], 'LevelThree' => [ 'shape' => 'HierarchyGroupSummaryReference', ], 'LevelFour' => [ 'shape' => 'HierarchyGroupSummaryReference', ], 'LevelFive' => [ 'shape' => 'HierarchyGroupSummaryReference', ], ], ], 'HierarchyRestrictedResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HierarchyRestrictedResourceName', ], ], 'HierarchyRestrictedResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'HierarchyStructure' => [ 'type' => 'structure', 'members' => [ 'LevelOne' => [ 'shape' => 'HierarchyLevel', ], 'LevelTwo' => [ 'shape' => 'HierarchyLevel', ], 'LevelThree' => [ 'shape' => 'HierarchyLevel', ], 'LevelFour' => [ 'shape' => 'HierarchyLevel', ], 'LevelFive' => [ 'shape' => 'HierarchyLevel', ], ], ], 'HierarchyStructureUpdate' => [ 'type' => 'structure', 'members' => [ 'LevelOne' => [ 'shape' => 'HierarchyLevelUpdate', ], 'LevelTwo' => [ 'shape' => 'HierarchyLevelUpdate', ], 'LevelThree' => [ 'shape' => 'HierarchyLevelUpdate', ], 'LevelFour' => [ 'shape' => 'HierarchyLevelUpdate', ], 'LevelFive' => [ 'shape' => 'HierarchyLevelUpdate', ], ], ], 'HistoricalMetric' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'HistoricalMetricName', ], 'Threshold' => [ 'shape' => 'Threshold', 'box' => true, ], 'Statistic' => [ 'shape' => 'Statistic', ], 'Unit' => [ 'shape' => 'Unit', ], ], ], 'HistoricalMetricData' => [ 'type' => 'structure', 'members' => [ 'Metric' => [ 'shape' => 'HistoricalMetric', ], 'Value' => [ 'shape' => 'Value', 'box' => true, ], ], ], 'HistoricalMetricDataCollections' => [ 'type' => 'list', 'member' => [ 'shape' => 'HistoricalMetricData', ], ], 'HistoricalMetricName' => [ 'type' => 'string', 'enum' => [ 'CONTACTS_QUEUED', 'CONTACTS_HANDLED', 'CONTACTS_ABANDONED', 'CONTACTS_CONSULTED', 'CONTACTS_AGENT_HUNG_UP_FIRST', 'CONTACTS_HANDLED_INCOMING', 'CONTACTS_HANDLED_OUTBOUND', 'CONTACTS_HOLD_ABANDONS', 'CONTACTS_TRANSFERRED_IN', 'CONTACTS_TRANSFERRED_OUT', 'CONTACTS_TRANSFERRED_IN_FROM_QUEUE', 'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE', 'CONTACTS_MISSED', 'CALLBACK_CONTACTS_HANDLED', 'API_CONTACTS_HANDLED', 'OCCUPANCY', 'HANDLE_TIME', 'AFTER_CONTACT_WORK_TIME', 'QUEUED_TIME', 'ABANDON_TIME', 'QUEUE_ANSWER_TIME', 'HOLD_TIME', 'INTERACTION_TIME', 'INTERACTION_AND_HOLD_TIME', 'SERVICE_LEVEL', ], ], 'HistoricalMetricResult' => [ 'type' => 'structure', 'members' => [ 'Dimensions' => [ 'shape' => 'Dimensions', ], 'Collections' => [ 'shape' => 'HistoricalMetricDataCollections', ], ], ], 'HistoricalMetricResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'HistoricalMetricResult', ], ], 'HistoricalMetrics' => [ 'type' => 'list', 'member' => [ 'shape' => 'HistoricalMetric', ], ], 'Hours' => [ 'type' => 'integer', 'max' => 87600, 'min' => 0, ], 'Hours24Format' => [ 'type' => 'integer', 'max' => 23, 'min' => 0, ], 'HoursOfOperation' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], 'HoursOfOperationArn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'HoursOfOperationDescription', ], 'TimeZone' => [ 'shape' => 'TimeZone', ], 'Config' => [ 'shape' => 'HoursOfOperationConfigList', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HoursOfOperationConfig' => [ 'type' => 'structure', 'required' => [ 'Day', 'StartTime', 'EndTime', ], 'members' => [ 'Day' => [ 'shape' => 'HoursOfOperationDays', ], 'StartTime' => [ 'shape' => 'HoursOfOperationTimeSlice', ], 'EndTime' => [ 'shape' => 'HoursOfOperationTimeSlice', ], ], ], 'HoursOfOperationConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HoursOfOperationConfig', ], 'max' => 100, 'min' => 0, ], 'HoursOfOperationDays' => [ 'type' => 'string', 'enum' => [ 'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', ], ], 'HoursOfOperationDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'HoursOfOperationId' => [ 'type' => 'string', ], 'HoursOfOperationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HoursOfOperation', ], ], 'HoursOfOperationName' => [ 'type' => 'string', ], 'HoursOfOperationSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HoursOfOperationSearchCriteria', ], ], 'HoursOfOperationSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'HoursOfOperationSearchConditionList', ], 'AndConditions' => [ 'shape' => 'HoursOfOperationSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'HoursOfOperationSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'HoursOfOperationSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'HoursOfOperationId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'HoursOfOperationName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'HoursOfOperationSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'HoursOfOperationSummary', ], ], 'HoursOfOperationTimeSlice' => [ 'type' => 'structure', 'required' => [ 'Hours', 'Minutes', ], 'members' => [ 'Hours' => [ 'shape' => 'Hours24Format', 'box' => true, ], 'Minutes' => [ 'shape' => 'MinutesLimit60', 'box' => true, ], ], ], 'ISO8601Datetime' => [ 'type' => 'string', ], 'IdempotencyException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ImportPhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'SourcePhoneNumberArn', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'SourcePhoneNumberArn' => [ 'shape' => 'ARN', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'ImportPhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'InboundCallsEnabled' => [ 'type' => 'boolean', ], 'Index' => [ 'type' => 'integer', ], 'InitiationMethodList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContactInitiationMethod', ], ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], 'IdentityManagementType' => [ 'shape' => 'DirectoryType', ], 'InstanceAlias' => [ 'shape' => 'DirectoryAlias', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'ServiceRole' => [ 'shape' => 'ARN', ], 'InstanceStatus' => [ 'shape' => 'InstanceStatus', ], 'StatusReason' => [ 'shape' => 'InstanceStatusReason', ], 'InboundCallsEnabled' => [ 'shape' => 'InboundCallsEnabled', ], 'OutboundCallsEnabled' => [ 'shape' => 'OutboundCallsEnabled', ], 'InstanceAccessUrl' => [ 'shape' => 'Url', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'InstanceArn' => [ 'type' => 'string', 'pattern' => 'arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}', ], 'InstanceAttributeType' => [ 'type' => 'string', 'enum' => [ 'INBOUND_CALLS', 'OUTBOUND_CALLS', 'CONTACTFLOW_LOGS', 'CONTACT_LENS', 'AUTO_RESOLVE_BEST_VOICES', 'USE_CUSTOM_TTS_VOICES', 'EARLY_MEDIA', 'MULTI_PARTY_CONFERENCE', 'HIGH_VOLUME_OUTBOUND', 'ENHANCED_CONTACT_MONITORING', 'ENHANCED_CHAT_MONITORING', ], ], 'InstanceAttributeValue' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'InstanceId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'InstanceIdOrArn' => [ 'type' => 'string', 'max' => 250, 'min' => 1, 'pattern' => '^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'InstanceStatus' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'ACTIVE', 'CREATION_FAILED', ], ], 'InstanceStatusReason' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], ], 'InstanceStorageConfig' => [ 'type' => 'structure', 'required' => [ 'StorageType', ], 'members' => [ 'AssociationId' => [ 'shape' => 'AssociationId', ], 'StorageType' => [ 'shape' => 'StorageType', ], 'S3Config' => [ 'shape' => 'S3Config', ], 'KinesisVideoStreamConfig' => [ 'shape' => 'KinesisVideoStreamConfig', ], 'KinesisStreamConfig' => [ 'shape' => 'KinesisStreamConfig', ], 'KinesisFirehoseConfig' => [ 'shape' => 'KinesisFirehoseConfig', ], ], ], 'InstanceStorageConfigs' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceStorageConfig', ], ], 'InstanceStorageResourceType' => [ 'type' => 'string', 'enum' => [ 'CHAT_TRANSCRIPTS', 'CALL_RECORDINGS', 'SCHEDULED_REPORTS', 'MEDIA_STREAMS', 'CONTACT_TRACE_RECORDS', 'AGENT_EVENTS', 'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS', 'ATTACHMENTS', 'CONTACT_EVALUATIONS', 'SCREEN_RECORDINGS', 'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS', 'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS', ], ], 'InstanceSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], 'IdentityManagementType' => [ 'shape' => 'DirectoryType', ], 'InstanceAlias' => [ 'shape' => 'DirectoryAlias', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'ServiceRole' => [ 'shape' => 'ARN', ], 'InstanceStatus' => [ 'shape' => 'InstanceStatus', ], 'InboundCallsEnabled' => [ 'shape' => 'InboundCallsEnabled', ], 'OutboundCallsEnabled' => [ 'shape' => 'OutboundCallsEnabled', ], 'InstanceAccessUrl' => [ 'shape' => 'Url', ], ], ], 'InstanceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceSummary', ], ], 'Integer' => [ 'type' => 'integer', ], 'IntegerCount' => [ 'type' => 'integer', 'min' => 0, ], 'IntegrationAssociationId' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'IntegrationAssociationSummary' => [ 'type' => 'structure', 'members' => [ 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', ], 'IntegrationAssociationArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'IntegrationType' => [ 'shape' => 'IntegrationType', ], 'IntegrationArn' => [ 'shape' => 'ARN', ], 'SourceApplicationUrl' => [ 'shape' => 'URI', ], 'SourceApplicationName' => [ 'shape' => 'SourceApplicationName', ], 'SourceType' => [ 'shape' => 'SourceType', ], ], ], 'IntegrationAssociationSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntegrationAssociationSummary', ], ], 'IntegrationType' => [ 'type' => 'string', 'enum' => [ 'EVENT', 'VOICE_ID', 'PINPOINT_APP', 'WISDOM_ASSISTANT', 'WISDOM_KNOWLEDGE_BASE', 'WISDOM_QUICK_RESPONSES', 'CASES_DOMAIN', 'APPLICATION', 'FILE_SCANNER', ], ], 'InternalServiceException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, ], 'IntervalDetails' => [ 'type' => 'structure', 'members' => [ 'TimeZone' => [ 'shape' => 'String', ], 'IntervalPeriod' => [ 'shape' => 'IntervalPeriod', ], ], ], 'IntervalPeriod' => [ 'type' => 'string', 'enum' => [ 'FIFTEEN_MIN', 'THIRTY_MIN', 'HOUR', 'DAY', 'WEEK', 'TOTAL', ], ], 'InvalidContactFlowException' => [ 'type' => 'structure', 'members' => [ 'problems' => [ 'shape' => 'Problems', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidContactFlowModuleException' => [ 'type' => 'structure', 'members' => [ 'Problems' => [ 'shape' => 'Problems', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], 'Reason' => [ 'shape' => 'InvalidRequestExceptionReason', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidRequestExceptionReason' => [ 'type' => 'structure', 'members' => [ 'AttachedFileInvalidRequestExceptionReason' => [ 'shape' => 'AttachedFileInvalidRequestExceptionReason', ], ], 'union' => true, ], 'InvisibleFieldInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], ], ], 'InvisibleTaskTemplateFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'InvisibleFieldInfo', ], ], 'JoinToken' => [ 'type' => 'string', 'sensitive' => true, ], 'KeyId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'KinesisFirehoseConfig' => [ 'type' => 'structure', 'required' => [ 'FirehoseArn', ], 'members' => [ 'FirehoseArn' => [ 'shape' => 'ARN', ], ], ], 'KinesisStreamConfig' => [ 'type' => 'structure', 'required' => [ 'StreamArn', ], 'members' => [ 'StreamArn' => [ 'shape' => 'ARN', ], ], ], 'KinesisVideoStreamConfig' => [ 'type' => 'structure', 'required' => [ 'Prefix', 'RetentionPeriodHours', 'EncryptionConfig', ], 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'RetentionPeriodHours' => [ 'shape' => 'Hours', ], 'EncryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'LargeNextToken' => [ 'type' => 'string', 'max' => 100000, 'min' => 1, ], 'LexBot' => [ 'type' => 'structure', 'required' => [ 'Name', 'LexRegion', ], 'members' => [ 'Name' => [ 'shape' => 'BotName', ], 'LexRegion' => [ 'shape' => 'LexRegion', ], ], ], 'LexBotConfig' => [ 'type' => 'structure', 'members' => [ 'LexBot' => [ 'shape' => 'LexBot', ], 'LexV2Bot' => [ 'shape' => 'LexV2Bot', ], ], ], 'LexBotConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LexBotConfig', ], ], 'LexBotsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LexBot', ], ], 'LexRegion' => [ 'type' => 'string', 'max' => 60, ], 'LexV2Bot' => [ 'type' => 'structure', 'members' => [ 'AliasArn' => [ 'shape' => 'AliasArn', ], ], ], 'LexVersion' => [ 'type' => 'string', 'enum' => [ 'V1', 'V2', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'ListAgentStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'AgentStatusTypes' => [ 'shape' => 'AgentStatusTypes', 'location' => 'querystring', 'locationName' => 'AgentStatusTypes', ], ], ], 'ListAgentStatusResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'AgentStatusSummaryList' => [ 'shape' => 'AgentStatusSummaryList', ], ], ], 'ListAnalyticsDataAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'DataSetId' => [ 'shape' => 'DataSetId', 'location' => 'querystring', 'locationName' => 'DataSetId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListAnalyticsDataAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'Results' => [ 'shape' => 'AnalyticsDataAssociationResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApprovedOriginsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult25', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListApprovedOriginsResponse' => [ 'type' => 'structure', 'members' => [ 'Origins' => [ 'shape' => 'OriginsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListBotsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'LexVersion', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult25', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'LexVersion' => [ 'shape' => 'LexVersion', 'location' => 'querystring', 'locationName' => 'lexVersion', ], ], ], 'ListBotsResponse' => [ 'type' => 'structure', 'members' => [ 'LexBots' => [ 'shape' => 'LexBotConfigList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListContactEvaluationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'querystring', 'locationName' => 'contactId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListContactEvaluationsResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationSummaryList', ], 'members' => [ 'EvaluationSummaryList' => [ 'shape' => 'EvaluationSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListContactFlowModulesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'ContactFlowModuleState' => [ 'shape' => 'ContactFlowModuleState', 'location' => 'querystring', 'locationName' => 'state', ], ], ], 'ListContactFlowModulesResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowModulesSummaryList' => [ 'shape' => 'ContactFlowModulesSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListContactFlowsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowTypes' => [ 'shape' => 'ContactFlowTypes', 'location' => 'querystring', 'locationName' => 'contactFlowTypes', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListContactFlowsResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowSummaryList' => [ 'shape' => 'ContactFlowSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListContactReferencesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ReferenceTypes', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'ReferenceTypes' => [ 'shape' => 'ReferenceTypes', 'location' => 'querystring', 'locationName' => 'referenceTypes', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListContactReferencesResponse' => [ 'type' => 'structure', 'members' => [ 'ReferenceSummaryList' => [ 'shape' => 'ReferenceSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDefaultVocabulariesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'MaxResults' => [ 'shape' => 'MaxResult100', ], 'NextToken' => [ 'shape' => 'VocabularyNextToken', ], ], ], 'ListDefaultVocabulariesResponse' => [ 'type' => 'structure', 'required' => [ 'DefaultVocabularyList', ], 'members' => [ 'DefaultVocabularyList' => [ 'shape' => 'DefaultVocabularyList', ], 'NextToken' => [ 'shape' => 'VocabularyNextToken', ], ], ], 'ListEvaluationFormVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListEvaluationFormVersionsResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormVersionSummaryList', ], 'members' => [ 'EvaluationFormVersionSummaryList' => [ 'shape' => 'EvaluationFormVersionSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListEvaluationFormsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListEvaluationFormsResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormSummaryList', ], 'members' => [ 'EvaluationFormSummaryList' => [ 'shape' => 'EvaluationFormSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListFlowAssociationResourceType' => [ 'type' => 'string', 'enum' => [ 'VOICE_PHONE_NUMBER', ], ], 'ListFlowAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceType' => [ 'shape' => 'ListFlowAssociationResourceType', 'location' => 'querystring', 'locationName' => 'ResourceType', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListFlowAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'FlowAssociationSummaryList' => [ 'shape' => 'FlowAssociationSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListHoursOfOperationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListHoursOfOperationsResponse' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperationSummaryList' => [ 'shape' => 'HoursOfOperationSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInstanceAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult7', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListInstanceAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'Attributes' => [ 'shape' => 'AttributesList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInstanceStorageConfigsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ResourceType', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult10', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListInstanceStorageConfigsResponse' => [ 'type' => 'structure', 'members' => [ 'StorageConfigs' => [ 'shape' => 'InstanceStorageConfigs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult10', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListInstancesResponse' => [ 'type' => 'structure', 'members' => [ 'InstanceSummaryList' => [ 'shape' => 'InstanceSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListIntegrationAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationType' => [ 'shape' => 'IntegrationType', 'location' => 'querystring', 'locationName' => 'integrationType', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'IntegrationArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'integrationArn', ], ], ], 'ListIntegrationAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'IntegrationAssociationSummaryList' => [ 'shape' => 'IntegrationAssociationSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLambdaFunctionsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult25', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListLambdaFunctionsResponse' => [ 'type' => 'structure', 'members' => [ 'LambdaFunctions' => [ 'shape' => 'FunctionArnsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListLexBotsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult25', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListLexBotsResponse' => [ 'type' => 'structure', 'members' => [ 'LexBots' => [ 'shape' => 'LexBotsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPhoneNumbersRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PhoneNumberTypes' => [ 'shape' => 'PhoneNumberTypes', 'location' => 'querystring', 'locationName' => 'phoneNumberTypes', ], 'PhoneNumberCountryCodes' => [ 'shape' => 'PhoneNumberCountryCodes', 'location' => 'querystring', 'locationName' => 'phoneNumberCountryCodes', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListPhoneNumbersResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberSummaryList' => [ 'shape' => 'PhoneNumberSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPhoneNumbersSummary' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'SourcePhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'ListPhoneNumbersSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ListPhoneNumbersSummary', ], ], 'ListPhoneNumbersV2Request' => [ 'type' => 'structure', 'members' => [ 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'PhoneNumberCountryCodes' => [ 'shape' => 'PhoneNumberCountryCodes', ], 'PhoneNumberTypes' => [ 'shape' => 'PhoneNumberTypes', ], 'PhoneNumberPrefix' => [ 'shape' => 'PhoneNumberPrefix', ], ], ], 'ListPhoneNumbersV2Response' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'ListPhoneNumbersSummaryList' => [ 'shape' => 'ListPhoneNumbersSummaryList', ], ], ], 'ListPredefinedAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListPredefinedAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'PredefinedAttributeSummaryList' => [ 'shape' => 'PredefinedAttributeSummaryList', ], ], ], 'ListPromptsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListPromptsResponse' => [ 'type' => 'structure', 'members' => [ 'PromptSummaryList' => [ 'shape' => 'PromptSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListQueueQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListQueueQuickConnectsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'QuickConnectSummaryList' => [ 'shape' => 'QuickConnectSummaryList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueTypes' => [ 'shape' => 'QueueTypes', 'location' => 'querystring', 'locationName' => 'queueTypes', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListQueuesResponse' => [ 'type' => 'structure', 'members' => [ 'QueueSummaryList' => [ 'shape' => 'QueueSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'QuickConnectTypes' => [ 'shape' => 'QuickConnectTypes', 'location' => 'querystring', 'locationName' => 'QuickConnectTypes', ], ], ], 'ListQuickConnectsResponse' => [ 'type' => 'structure', 'members' => [ 'QuickConnectSummaryList' => [ 'shape' => 'QuickConnectSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRealtimeContactAnalysisSegmentsV2Request' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'OutputType', 'SegmentTypes', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'MaxResults' => [ 'shape' => 'MaxResult100', ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'OutputType' => [ 'shape' => 'RealTimeContactAnalysisOutputType', ], 'SegmentTypes' => [ 'shape' => 'RealTimeContactAnalysisSegmentTypes', ], ], ], 'ListRealtimeContactAnalysisSegmentsV2Response' => [ 'type' => 'structure', 'required' => [ 'Channel', 'Status', 'Segments', ], 'members' => [ 'Channel' => [ 'shape' => 'RealTimeContactAnalysisSupportedChannel', ], 'Status' => [ 'shape' => 'RealTimeContactAnalysisStatus', ], 'Segments' => [ 'shape' => 'RealtimeContactAnalysisSegments', ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], ], ], 'ListRoutingProfileQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRoutingProfileQueuesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'RoutingProfileQueueConfigSummaryList' => [ 'shape' => 'RoutingProfileQueueConfigSummaryList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListRoutingProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRoutingProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'RoutingProfileSummaryList' => [ 'shape' => 'RoutingProfileSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListRulesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', 'location' => 'querystring', 'locationName' => 'publishStatus', ], 'EventSourceName' => [ 'shape' => 'EventSourceName', 'location' => 'querystring', 'locationName' => 'eventSourceName', ], 'MaxResults' => [ 'shape' => 'MaxResult200', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListRulesResponse' => [ 'type' => 'structure', 'required' => [ 'RuleSummaryList', ], 'members' => [ 'RuleSummaryList' => [ 'shape' => 'RuleSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSecurityKeysRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult2', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSecurityKeysResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityKeys' => [ 'shape' => 'SecurityKeysList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSecurityProfileApplicationsRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileId', 'InstanceId', ], 'members' => [ 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSecurityProfileApplicationsResponse' => [ 'type' => 'structure', 'members' => [ 'Applications' => [ 'shape' => 'Applications', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListSecurityProfilePermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileId', 'InstanceId', ], 'members' => [ 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSecurityProfilePermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'PermissionsList', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListSecurityProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSecurityProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityProfileSummaryList' => [ 'shape' => 'SecurityProfileSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'ListTaskTemplatesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', 'location' => 'querystring', 'locationName' => 'status', ], 'Name' => [ 'shape' => 'TaskTemplateName', 'location' => 'querystring', 'locationName' => 'name', ], ], ], 'ListTaskTemplatesResponse' => [ 'type' => 'structure', 'members' => [ 'TaskTemplates' => [ 'shape' => 'TaskTemplateList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTrafficDistributionGroupUsersRequest' => [ 'type' => 'structure', 'required' => [ 'TrafficDistributionGroupId', ], 'members' => [ 'TrafficDistributionGroupId' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'TrafficDistributionGroupId', ], 'MaxResults' => [ 'shape' => 'MaxResult10', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListTrafficDistributionGroupUsersResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'TrafficDistributionGroupUserSummaryList' => [ 'shape' => 'TrafficDistributionGroupUserSummaryList', ], ], ], 'ListTrafficDistributionGroupsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResult10', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'InstanceId' => [ 'shape' => 'InstanceIdOrArn', 'location' => 'querystring', 'locationName' => 'instanceId', ], ], ], 'ListTrafficDistributionGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'TrafficDistributionGroupSummaryList' => [ 'shape' => 'TrafficDistributionGroupSummaryList', ], ], ], 'ListUseCasesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'IntegrationAssociationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', 'location' => 'uri', 'locationName' => 'IntegrationAssociationId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListUseCasesResponse' => [ 'type' => 'structure', 'members' => [ 'UseCaseSummaryList' => [ 'shape' => 'UseCaseSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserHierarchyGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListUserHierarchyGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'UserHierarchyGroupSummaryList' => [ 'shape' => 'HierarchyGroupSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListUserProficienciesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListUserProficienciesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'UserProficiencyList' => [ 'shape' => 'UserProficiencyList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'ListUsersRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResult1000', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListUsersResponse' => [ 'type' => 'structure', 'members' => [ 'UserSummaryList' => [ 'shape' => 'UserSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListViewVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'NextToken' => [ 'shape' => 'ViewsNextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListViewVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ViewVersionSummaryList' => [ 'shape' => 'ViewVersionSummaryList', ], 'NextToken' => [ 'shape' => 'ViewsNextToken', ], ], ], 'ListViewsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Type' => [ 'shape' => 'ViewType', 'location' => 'querystring', 'locationName' => 'type', ], 'NextToken' => [ 'shape' => 'ViewsNextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'box' => true, 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListViewsResponse' => [ 'type' => 'structure', 'members' => [ 'ViewsSummaryList' => [ 'shape' => 'ViewsSummaryList', ], 'NextToken' => [ 'shape' => 'ViewsNextToken', ], ], ], 'Long' => [ 'type' => 'long', ], 'MatchCriteria' => [ 'type' => 'structure', 'members' => [ 'AgentsCriteria' => [ 'shape' => 'AgentsCriteria', ], ], ], 'MaxResult10' => [ 'type' => 'integer', 'max' => 10, 'min' => 1, ], 'MaxResult100' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaxResult1000' => [ 'type' => 'integer', 'max' => 1000, 'min' => 1, ], 'MaxResult2' => [ 'type' => 'integer', 'max' => 2, 'min' => 1, ], 'MaxResult200' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'MaxResult25' => [ 'type' => 'integer', 'max' => 25, 'min' => 1, ], 'MaxResult500' => [ 'type' => 'integer', 'box' => true, 'max' => 500, 'min' => 1, ], 'MaxResult7' => [ 'type' => 'integer', 'max' => 7, 'min' => 1, ], 'MaxResults' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MaximumResultReturnedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'MediaConcurrencies' => [ 'type' => 'list', 'member' => [ 'shape' => 'MediaConcurrency', ], ], 'MediaConcurrency' => [ 'type' => 'structure', 'required' => [ 'Channel', 'Concurrency', ], 'members' => [ 'Channel' => [ 'shape' => 'Channel', ], 'Concurrency' => [ 'shape' => 'Concurrency', ], 'CrossChannelBehavior' => [ 'shape' => 'CrossChannelBehavior', ], ], ], 'MediaPlacement' => [ 'type' => 'structure', 'members' => [ 'AudioHostUrl' => [ 'shape' => 'URI', ], 'AudioFallbackUrl' => [ 'shape' => 'URI', ], 'SignalingUrl' => [ 'shape' => 'URI', ], 'TurnControlUrl' => [ 'shape' => 'URI', ], 'EventIngestionUrl' => [ 'shape' => 'URI', ], ], ], 'MediaRegion' => [ 'type' => 'string', ], 'Meeting' => [ 'type' => 'structure', 'members' => [ 'MediaRegion' => [ 'shape' => 'MediaRegion', ], 'MediaPlacement' => [ 'shape' => 'MediaPlacement', ], 'MeetingFeatures' => [ 'shape' => 'MeetingFeaturesConfiguration', ], 'MeetingId' => [ 'shape' => 'MeetingId', ], ], ], 'MeetingFeatureStatus' => [ 'type' => 'string', 'enum' => [ 'AVAILABLE', 'UNAVAILABLE', ], ], 'MeetingFeaturesConfiguration' => [ 'type' => 'structure', 'members' => [ 'Audio' => [ 'shape' => 'AudioFeatures', ], ], ], 'MeetingId' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'MetadataUrl' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, ], 'MetricDataCollectionsV2' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDataV2', ], ], 'MetricDataV2' => [ 'type' => 'structure', 'members' => [ 'Metric' => [ 'shape' => 'MetricV2', ], 'Value' => [ 'shape' => 'Value', 'box' => true, ], ], ], 'MetricFilterV2' => [ 'type' => 'structure', 'members' => [ 'MetricFilterKey' => [ 'shape' => 'String', ], 'MetricFilterValues' => [ 'shape' => 'MetricFilterValueList', ], 'Negate' => [ 'shape' => 'Boolean', ], ], ], 'MetricFilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 10, 'min' => 1, ], 'MetricFiltersV2List' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricFilterV2', ], 'max' => 2, ], 'MetricInterval' => [ 'type' => 'structure', 'members' => [ 'Interval' => [ 'shape' => 'IntervalPeriod', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'MetricNameV2' => [ 'type' => 'string', ], 'MetricResultV2' => [ 'type' => 'structure', 'members' => [ 'Dimensions' => [ 'shape' => 'DimensionsV2Map', ], 'MetricInterval' => [ 'shape' => 'MetricInterval', ], 'Collections' => [ 'shape' => 'MetricDataCollectionsV2', ], ], ], 'MetricResultsV2' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricResultV2', ], ], 'MetricV2' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'MetricNameV2', ], 'Threshold' => [ 'shape' => 'ThresholdCollections', ], 'MetricFilters' => [ 'shape' => 'MetricFiltersV2List', ], ], ], 'MetricsV2' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricV2', ], ], 'MinutesLimit60' => [ 'type' => 'integer', 'max' => 59, 'min' => 0, ], 'MonitorCapability' => [ 'type' => 'string', 'enum' => [ 'SILENT_MONITOR', 'BARGE', ], ], 'MonitorContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'UserId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'UserId' => [ 'shape' => 'AgentResourceId', ], 'AllowedMonitorCapabilities' => [ 'shape' => 'AllowedMonitorCapabilities', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'MonitorContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'ContactArn' => [ 'shape' => 'ARN', ], ], ], 'Name' => [ 'type' => 'string', 'max' => 512, 'min' => 0, 'sensitive' => true, ], 'Name128' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '(^[\\S].*[\\S]$)|(^[\\S]$)', ], 'Namespace' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'NewChatCreated' => [ 'type' => 'boolean', ], 'NewSessionDetails' => [ 'type' => 'structure', 'members' => [ 'SupportedMessagingContentTypes' => [ 'shape' => 'SupportedMessagingContentTypes', ], 'ParticipantDetails' => [ 'shape' => 'ParticipantDetails', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'StreamingConfiguration' => [ 'shape' => 'ChatStreamingConfiguration', ], ], ], 'NextToken' => [ 'type' => 'string', ], 'NextToken2500' => [ 'type' => 'string', 'max' => 2500, 'min' => 1, ], 'NotificationContentType' => [ 'type' => 'string', 'enum' => [ 'PLAIN_TEXT', ], ], 'NotificationDeliveryType' => [ 'type' => 'string', 'enum' => [ 'EMAIL', ], ], 'NotificationRecipientType' => [ 'type' => 'structure', 'members' => [ 'UserTags' => [ 'shape' => 'UserTagMap', ], 'UserIds' => [ 'shape' => 'UserIdList', ], ], ], 'NullableProficiencyLevel' => [ 'type' => 'float', 'max' => 5.0, 'min' => 1.0, ], 'NumberReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'NumericQuestionPropertyAutomationLabel' => [ 'type' => 'string', 'enum' => [ 'OVERALL_CUSTOMER_SENTIMENT_SCORE', 'OVERALL_AGENT_SENTIMENT_SCORE', 'NON_TALK_TIME', 'NON_TALK_TIME_PERCENTAGE', 'NUMBER_OF_INTERRUPTIONS', 'CONTACT_DURATION', 'AGENT_INTERACTION_DURATION', 'CUSTOMER_HOLD_TIME', ], ], 'NumericQuestionPropertyValueAutomation' => [ 'type' => 'structure', 'required' => [ 'Label', ], 'members' => [ 'Label' => [ 'shape' => 'NumericQuestionPropertyAutomationLabel', ], ], ], 'OperatingSystem' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'Origin' => [ 'type' => 'string', 'max' => 267, ], 'OriginsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Origin', ], ], 'OutboundCallerConfig' => [ 'type' => 'structure', 'members' => [ 'OutboundCallerIdName' => [ 'shape' => 'OutboundCallerIdName', ], 'OutboundCallerIdNumberId' => [ 'shape' => 'PhoneNumberId', ], 'OutboundFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'OutboundCallerIdName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'OutboundCallsEnabled' => [ 'type' => 'boolean', ], 'OutboundContactNotPermittedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'OutputTypeNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'PEM' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ParticipantCapabilities' => [ 'type' => 'structure', 'members' => [ 'Video' => [ 'shape' => 'VideoCapability', ], ], ], 'ParticipantDetails' => [ 'type' => 'structure', 'required' => [ 'DisplayName', ], 'members' => [ 'DisplayName' => [ 'shape' => 'DisplayName', ], ], ], 'ParticipantDetailsToAdd' => [ 'type' => 'structure', 'members' => [ 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], ], ], 'ParticipantId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ParticipantRole' => [ 'type' => 'string', 'enum' => [ 'AGENT', 'CUSTOMER', 'SYSTEM', 'CUSTOM_BOT', 'SUPERVISOR', ], ], 'ParticipantTimerAction' => [ 'type' => 'string', 'enum' => [ 'Unset', ], ], 'ParticipantTimerConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParticipantTimerConfiguration', ], 'max' => 6, 'min' => 1, ], 'ParticipantTimerConfiguration' => [ 'type' => 'structure', 'required' => [ 'ParticipantRole', 'TimerType', 'TimerValue', ], 'members' => [ 'ParticipantRole' => [ 'shape' => 'TimerEligibleParticipantRoles', ], 'TimerType' => [ 'shape' => 'ParticipantTimerType', ], 'TimerValue' => [ 'shape' => 'ParticipantTimerValue', ], ], ], 'ParticipantTimerDurationInMinutes' => [ 'type' => 'integer', 'max' => 480, 'min' => 2, ], 'ParticipantTimerType' => [ 'type' => 'string', 'enum' => [ 'IDLE', 'DISCONNECT_NONCUSTOMER', ], ], 'ParticipantTimerValue' => [ 'type' => 'structure', 'members' => [ 'ParticipantTimerAction' => [ 'shape' => 'ParticipantTimerAction', ], 'ParticipantTimerDurationInMinutes' => [ 'shape' => 'ParticipantTimerDurationInMinutes', ], ], 'union' => true, ], 'ParticipantToken' => [ 'type' => 'string', 'max' => 1000, 'min' => 1, ], 'ParticipantTokenCredentials' => [ 'type' => 'structure', 'members' => [ 'ParticipantToken' => [ 'shape' => 'ParticipantToken', ], 'Expiry' => [ 'shape' => 'ISO8601Datetime', ], ], ], 'Password' => [ 'type' => 'string', 'pattern' => '/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/', 'sensitive' => true, ], 'PauseContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'PauseContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'Permission' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'PermissionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfilePermission', ], 'max' => 500, ], 'PersistentChat' => [ 'type' => 'structure', 'members' => [ 'RehydrationType' => [ 'shape' => 'RehydrationType', ], 'SourceContactId' => [ 'shape' => 'ContactId', ], ], ], 'PhoneNumber' => [ 'type' => 'string', 'pattern' => '\\\\+[1-9]\\\\d{1,14}$', ], 'PhoneNumberCountryCode' => [ 'type' => 'string', 'enum' => [ 'AF', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BA', 'BW', 'BR', 'IO', 'VG', 'BN', 'BG', 'BF', 'BI', 'KH', 'CM', 'CA', 'CV', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CK', 'CR', 'HR', 'CU', 'CW', 'CY', 'CZ', 'CD', 'DK', 'DJ', 'DM', 'DO', 'TL', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'PF', 'GA', 'GM', 'GE', 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT', 'CI', 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KW', 'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MR', 'MU', 'YT', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP', 'NL', 'AN', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'KP', 'MP', 'NO', 'OM', 'PK', 'PW', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR', 'QA', 'CG', 'RE', 'RO', 'RU', 'RW', 'BL', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS', 'SM', 'ST', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB', 'SO', 'ZA', 'KR', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'VI', 'UG', 'UA', 'AE', 'GB', 'US', 'UY', 'UZ', 'VU', 'VA', 'VE', 'VN', 'WF', 'EH', 'YE', 'ZM', 'ZW', ], ], 'PhoneNumberCountryCodes' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberCountryCode', ], 'max' => 10, ], 'PhoneNumberDescription' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^[\\W\\S_]*', ], 'PhoneNumberId' => [ 'type' => 'string', ], 'PhoneNumberPrefix' => [ 'type' => 'string', 'pattern' => '\\\\+?[0-9]{1,11}', ], 'PhoneNumberQuickConnectConfig' => [ 'type' => 'structure', 'required' => [ 'PhoneNumber', ], 'members' => [ 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'PhoneNumberStatus' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'PhoneNumberWorkflowStatus', ], 'Message' => [ 'shape' => 'PhoneNumberWorkflowMessage', ], ], ], 'PhoneNumberSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'PhoneNumberId', ], 'Arn' => [ 'shape' => 'ARN', ], 'PhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], ], ], 'PhoneNumberSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberSummary', ], ], 'PhoneNumberType' => [ 'type' => 'string', 'enum' => [ 'TOLL_FREE', 'DID', 'UIFN', 'SHARED', 'THIRD_PARTY_TF', 'THIRD_PARTY_DID', 'SHORT_CODE', ], ], 'PhoneNumberTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'PhoneNumberType', ], 'max' => 6, ], 'PhoneNumberWorkflowMessage' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '^[\\W\\S_]*', ], 'PhoneNumberWorkflowStatus' => [ 'type' => 'string', 'enum' => [ 'CLAIMED', 'IN_PROGRESS', 'FAILED', ], ], 'PhoneType' => [ 'type' => 'string', 'enum' => [ 'SOFT_PHONE', 'DESK_PHONE', ], ], 'PlatformName' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'PlatformVersion' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'PotentialAudioQualityIssue' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'PotentialAudioQualityIssues' => [ 'type' => 'list', 'member' => [ 'shape' => 'PotentialAudioQualityIssue', ], 'max' => 3, 'min' => 0, ], 'PotentialDisconnectIssue' => [ 'type' => 'string', 'max' => 128, 'min' => 0, ], 'PredefinedAttribute' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'PredefinedAttributeName', ], 'Values' => [ 'shape' => 'PredefinedAttributeValues', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'PredefinedAttributeName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'PredefinedAttributeSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PredefinedAttributeSearchCriteria', ], ], 'PredefinedAttributeSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'PredefinedAttributeSearchConditionList', ], 'AndConditions' => [ 'shape' => 'PredefinedAttributeSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'PredefinedAttributeSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PredefinedAttribute', ], ], 'PredefinedAttributeStringValue' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'PredefinedAttributeStringValuesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PredefinedAttributeStringValue', ], 'max' => 128, 'min' => 1, ], 'PredefinedAttributeSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'PredefinedAttributeName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'PredefinedAttributeSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PredefinedAttributeSummary', ], ], 'PredefinedAttributeValues' => [ 'type' => 'structure', 'members' => [ 'StringList' => [ 'shape' => 'PredefinedAttributeStringValuesList', ], ], 'union' => true, ], 'Prefix' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'Priority' => [ 'type' => 'integer', 'max' => 99, 'min' => 1, ], 'ProblemDetail' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ProblemMessageString', ], ], ], 'ProblemMessageString' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'Problems' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProblemDetail', ], 'max' => 50, 'min' => 1, ], 'ProficiencyLevel' => [ 'type' => 'float', 'box' => true, 'max' => 5.0, 'min' => 1.0, ], 'ProficiencyValue' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'Prompt' => [ 'type' => 'structure', 'members' => [ 'PromptARN' => [ 'shape' => 'ARN', ], 'PromptId' => [ 'shape' => 'PromptId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'PromptDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'PromptDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'PromptId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'PromptList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Prompt', ], ], 'PromptName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'PromptPresignedUrl' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, ], 'PromptSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PromptSearchCriteria', ], ], 'PromptSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'PromptSearchConditionList', ], 'AndConditions' => [ 'shape' => 'PromptSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'PromptSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'PromptSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'PromptId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'PromptName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'PromptSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PromptSummary', ], ], 'PropertyValidationException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'Message', ], 'PropertyList' => [ 'shape' => 'PropertyValidationExceptionPropertyList', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'PropertyValidationExceptionProperty' => [ 'type' => 'structure', 'required' => [ 'PropertyPath', 'Reason', 'Message', ], 'members' => [ 'PropertyPath' => [ 'shape' => 'String', ], 'Reason' => [ 'shape' => 'PropertyValidationExceptionReason', ], 'Message' => [ 'shape' => 'Message', ], ], ], 'PropertyValidationExceptionPropertyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyValidationExceptionProperty', ], ], 'PropertyValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'INVALID_FORMAT', 'UNIQUE_CONSTRAINT_VIOLATED', 'REFERENCED_RESOURCE_NOT_FOUND', 'RESOURCE_NAME_ALREADY_EXISTS', 'REQUIRED_PROPERTY_MISSING', 'NOT_SUPPORTED', ], ], 'PutUserStatusRequest' => [ 'type' => 'structure', 'required' => [ 'UserId', 'InstanceId', 'AgentStatusId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', ], ], ], 'PutUserStatusResponse' => [ 'type' => 'structure', 'members' => [], ], 'QualityMetrics' => [ 'type' => 'structure', 'members' => [ 'Agent' => [ 'shape' => 'AgentQualityMetrics', ], 'Customer' => [ 'shape' => 'CustomerQualityMetrics', ], ], ], 'Queue' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'CommonNameLength127', ], 'QueueArn' => [ 'shape' => 'ARN', ], 'QueueId' => [ 'shape' => 'QueueId', ], 'Description' => [ 'shape' => 'QueueDescription', ], 'OutboundCallerConfig' => [ 'shape' => 'OutboundCallerConfig', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], 'MaxContacts' => [ 'shape' => 'QueueMaxContacts', 'box' => true, ], 'Status' => [ 'shape' => 'QueueStatus', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'QueueDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'QueueId' => [ 'type' => 'string', ], 'QueueIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueId', ], 'max' => 100, 'min' => 0, ], 'QueueInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QueueId', ], 'EnqueueTimestamp' => [ 'shape' => 'timestamp', ], ], ], 'QueueMaxContacts' => [ 'type' => 'integer', 'min' => 0, ], 'QueueName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'QueuePriority' => [ 'type' => 'long', 'max' => 9223372036854775807, 'min' => 1, ], 'QueueQuickConnectConfig' => [ 'type' => 'structure', 'required' => [ 'QueueId', 'ContactFlowId', ], 'members' => [ 'QueueId' => [ 'shape' => 'QueueId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'QueueReference' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QueueId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'QueueSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueSearchCriteria', ], ], 'QueueSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'QueueSearchConditionList', ], 'AndConditions' => [ 'shape' => 'QueueSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], 'QueueTypeCondition' => [ 'shape' => 'SearchableQueueType', ], ], ], 'QueueSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'QueueSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Queue', ], ], 'QueueStatus' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'QueueSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QueueId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'QueueName', ], 'QueueType' => [ 'shape' => 'QueueType', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'QueueSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueSummary', ], ], 'QueueTimeAdjustmentSeconds' => [ 'type' => 'integer', ], 'QueueType' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'AGENT', ], ], 'QueueTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueType', ], 'max' => 2, ], 'Queues' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueId', ], 'max' => 100, 'min' => 1, ], 'QuickConnect' => [ 'type' => 'structure', 'members' => [ 'QuickConnectARN' => [ 'shape' => 'ARN', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', ], 'Name' => [ 'shape' => 'QuickConnectName', ], 'Description' => [ 'shape' => 'QuickConnectDescription', ], 'QuickConnectConfig' => [ 'shape' => 'QuickConnectConfig', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'QuickConnectConfig' => [ 'type' => 'structure', 'required' => [ 'QuickConnectType', ], 'members' => [ 'QuickConnectType' => [ 'shape' => 'QuickConnectType', ], 'UserConfig' => [ 'shape' => 'UserQuickConnectConfig', ], 'QueueConfig' => [ 'shape' => 'QueueQuickConnectConfig', ], 'PhoneConfig' => [ 'shape' => 'PhoneNumberQuickConnectConfig', ], ], ], 'QuickConnectDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'QuickConnectId' => [ 'type' => 'string', ], 'QuickConnectName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'QuickConnectSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnectSearchCriteria', ], ], 'QuickConnectSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'QuickConnectSearchConditionList', ], 'AndConditions' => [ 'shape' => 'QuickConnectSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'QuickConnectSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'QuickConnectSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnect', ], ], 'QuickConnectSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'QuickConnectId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'QuickConnectName', ], 'QuickConnectType' => [ 'shape' => 'QuickConnectType', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'QuickConnectSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnectSummary', ], ], 'QuickConnectType' => [ 'type' => 'string', 'enum' => [ 'USER', 'QUEUE', 'PHONE_NUMBER', ], ], 'QuickConnectTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnectType', ], 'max' => 3, ], 'QuickConnectsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QuickConnectId', ], 'max' => 50, 'min' => 1, ], 'ReadOnlyFieldInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], ], ], 'ReadOnlyTaskTemplateFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReadOnlyFieldInfo', ], ], 'RealTimeContactAnalysisAttachment' => [ 'type' => 'structure', 'required' => [ 'AttachmentName', 'AttachmentId', ], 'members' => [ 'AttachmentName' => [ 'shape' => 'AttachmentName', ], 'ContentType' => [ 'shape' => 'ContentType', ], 'AttachmentId' => [ 'shape' => 'ArtifactId', ], 'Status' => [ 'shape' => 'ArtifactStatus', ], ], ], 'RealTimeContactAnalysisAttachments' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisAttachment', ], 'max' => 10, ], 'RealTimeContactAnalysisCategoryDetails' => [ 'type' => 'structure', 'required' => [ 'PointsOfInterest', ], 'members' => [ 'PointsOfInterest' => [ 'shape' => 'RealTimeContactAnalysisPointsOfInterest', ], ], ], 'RealTimeContactAnalysisCategoryName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RealTimeContactAnalysisCharacterInterval' => [ 'type' => 'structure', 'required' => [ 'BeginOffsetChar', 'EndOffsetChar', ], 'members' => [ 'BeginOffsetChar' => [ 'shape' => 'RealTimeContactAnalysisOffset', ], 'EndOffsetChar' => [ 'shape' => 'RealTimeContactAnalysisOffset', ], ], ], 'RealTimeContactAnalysisCharacterIntervals' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisCharacterInterval', ], ], 'RealTimeContactAnalysisContentType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RealTimeContactAnalysisEventType' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'RealTimeContactAnalysisId256' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RealTimeContactAnalysisIssueDetected' => [ 'type' => 'structure', 'required' => [ 'TranscriptItems', ], 'members' => [ 'TranscriptItems' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemsWithContent', ], ], ], 'RealTimeContactAnalysisIssuesDetected' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisIssueDetected', ], ], 'RealTimeContactAnalysisMatchedDetails' => [ 'type' => 'map', 'key' => [ 'shape' => 'RealTimeContactAnalysisCategoryName', ], 'value' => [ 'shape' => 'RealTimeContactAnalysisCategoryDetails', ], 'max' => 150, 'min' => 0, ], 'RealTimeContactAnalysisOffset' => [ 'type' => 'integer', 'min' => 0, ], 'RealTimeContactAnalysisOutputType' => [ 'type' => 'string', 'enum' => [ 'Raw', 'Redacted', ], ], 'RealTimeContactAnalysisPointOfInterest' => [ 'type' => 'structure', 'members' => [ 'TranscriptItems' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets', ], ], ], 'RealTimeContactAnalysisPointsOfInterest' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisPointOfInterest', ], 'max' => 5, 'min' => 0, ], 'RealTimeContactAnalysisSegmentAttachments' => [ 'type' => 'structure', 'required' => [ 'Id', 'ParticipantId', 'ParticipantRole', 'Attachments', 'Time', ], 'members' => [ 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], 'Attachments' => [ 'shape' => 'RealTimeContactAnalysisAttachments', ], 'Time' => [ 'shape' => 'RealTimeContactAnalysisTimeData', ], ], ], 'RealTimeContactAnalysisSegmentCategories' => [ 'type' => 'structure', 'required' => [ 'MatchedDetails', ], 'members' => [ 'MatchedDetails' => [ 'shape' => 'RealTimeContactAnalysisMatchedDetails', ], ], ], 'RealTimeContactAnalysisSegmentEvent' => [ 'type' => 'structure', 'required' => [ 'Id', 'EventType', 'Time', ], 'members' => [ 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], 'EventType' => [ 'shape' => 'RealTimeContactAnalysisEventType', ], 'Time' => [ 'shape' => 'RealTimeContactAnalysisTimeData', ], ], ], 'RealTimeContactAnalysisSegmentIssues' => [ 'type' => 'structure', 'required' => [ 'IssuesDetected', ], 'members' => [ 'IssuesDetected' => [ 'shape' => 'RealTimeContactAnalysisIssuesDetected', ], ], ], 'RealTimeContactAnalysisSegmentTranscript' => [ 'type' => 'structure', 'required' => [ 'Id', 'ParticipantId', 'ParticipantRole', 'Content', 'Time', ], 'members' => [ 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], 'Content' => [ 'shape' => 'RealTimeContactAnalysisTranscriptContent', ], 'ContentType' => [ 'shape' => 'RealTimeContactAnalysisContentType', ], 'Time' => [ 'shape' => 'RealTimeContactAnalysisTimeData', ], 'Redaction' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemRedaction', ], 'Sentiment' => [ 'shape' => 'RealTimeContactAnalysisSentimentLabel', ], ], ], 'RealTimeContactAnalysisSegmentType' => [ 'type' => 'string', 'enum' => [ 'Transcript', 'Categories', 'Issues', 'Event', 'Attachments', ], ], 'RealTimeContactAnalysisSegmentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisSegmentType', ], 'max' => 5, ], 'RealTimeContactAnalysisSentimentLabel' => [ 'type' => 'string', 'enum' => [ 'POSITIVE', 'NEGATIVE', 'NEUTRAL', ], ], 'RealTimeContactAnalysisStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'FAILED', 'COMPLETED', ], ], 'RealTimeContactAnalysisSupportedChannel' => [ 'type' => 'string', 'enum' => [ 'VOICE', 'CHAT', ], ], 'RealTimeContactAnalysisTimeData' => [ 'type' => 'structure', 'members' => [ 'AbsoluteTime' => [ 'shape' => 'RealTimeContactAnalysisTimeInstant', ], ], 'union' => true, ], 'RealTimeContactAnalysisTimeInstant' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'RealTimeContactAnalysisTranscriptContent' => [ 'type' => 'string', 'max' => 16384, 'min' => 1, ], 'RealTimeContactAnalysisTranscriptItemRedaction' => [ 'type' => 'structure', 'members' => [ 'CharacterOffsets' => [ 'shape' => 'RealTimeContactAnalysisCharacterIntervals', ], ], ], 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'CharacterOffsets' => [ 'shape' => 'RealTimeContactAnalysisCharacterInterval', ], ], ], 'RealTimeContactAnalysisTranscriptItemWithContent' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Content' => [ 'shape' => 'RealTimeContactAnalysisTranscriptContent', ], 'Id' => [ 'shape' => 'RealTimeContactAnalysisId256', ], 'CharacterOffsets' => [ 'shape' => 'RealTimeContactAnalysisCharacterInterval', ], ], ], 'RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets', ], 'max' => 10, 'min' => 0, ], 'RealTimeContactAnalysisTranscriptItemsWithContent' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealTimeContactAnalysisTranscriptItemWithContent', ], ], 'RealtimeContactAnalysisSegment' => [ 'type' => 'structure', 'members' => [ 'Transcript' => [ 'shape' => 'RealTimeContactAnalysisSegmentTranscript', ], 'Categories' => [ 'shape' => 'RealTimeContactAnalysisSegmentCategories', ], 'Issues' => [ 'shape' => 'RealTimeContactAnalysisSegmentIssues', ], 'Event' => [ 'shape' => 'RealTimeContactAnalysisSegmentEvent', ], 'Attachments' => [ 'shape' => 'RealTimeContactAnalysisSegmentAttachments', ], ], 'union' => true, ], 'RealtimeContactAnalysisSegments' => [ 'type' => 'list', 'member' => [ 'shape' => 'RealtimeContactAnalysisSegment', ], ], 'Reference' => [ 'type' => 'structure', 'required' => [ 'Value', 'Type', ], 'members' => [ 'Value' => [ 'shape' => 'ReferenceValue', ], 'Type' => [ 'shape' => 'ReferenceType', ], ], ], 'ReferenceId' => [ 'type' => 'string', 'max' => 40, 'min' => 1, ], 'ReferenceKey' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, ], 'ReferenceStatus' => [ 'type' => 'string', 'enum' => [ 'APPROVED', 'REJECTED', ], ], 'ReferenceSummary' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'UrlReference', ], 'Attachment' => [ 'shape' => 'AttachmentReference', ], 'String' => [ 'shape' => 'StringReference', ], 'Number' => [ 'shape' => 'NumberReference', ], 'Date' => [ 'shape' => 'DateReference', ], 'Email' => [ 'shape' => 'EmailReference', ], ], 'union' => true, ], 'ReferenceSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceSummary', ], ], 'ReferenceType' => [ 'type' => 'string', 'enum' => [ 'URL', 'ATTACHMENT', 'NUMBER', 'STRING', 'DATE', 'EMAIL', ], ], 'ReferenceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceType', ], 'max' => 6, ], 'ReferenceValue' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, ], 'RegionName' => [ 'type' => 'string', 'pattern' => '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?', ], 'RehydrationType' => [ 'type' => 'string', 'enum' => [ 'ENTIRE_PAST_SESSION', 'FROM_SEGMENT', ], ], 'ReleasePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, 'location' => 'querystring', 'locationName' => 'clientToken', ], ], ], 'ReplicateInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ReplicaRegion', 'ReplicaAlias', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceIdOrArn', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ReplicaRegion' => [ 'shape' => 'AwsRegion', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ReplicaAlias' => [ 'shape' => 'DirectoryAlias', ], ], ], 'ReplicateInstanceResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'RequestIdentifier' => [ 'type' => 'string', 'max' => 80, ], 'RequiredFieldInfo' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], ], ], 'RequiredTaskTemplateFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'RequiredFieldInfo', ], ], 'ResourceArnOrId' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'ResourceConflictException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], 'ResourceType' => [ 'shape' => 'ResourceType', ], 'ResourceId' => [ 'shape' => 'ARN', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResourceNotReadyException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ResourceTagsSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'TagSearchCondition' => [ 'shape' => 'TagSearchCondition', ], ], ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'CONTACT', 'CONTACT_FLOW', 'INSTANCE', 'PARTICIPANT', 'HIERARCHY_LEVEL', 'HIERARCHY_GROUP', 'USER', 'PHONE_NUMBER', ], ], 'ResourceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'ResumeContactRecordingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'InitialContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], ], ], 'ResumeContactRecordingResponse' => [ 'type' => 'structure', 'members' => [], ], 'ResumeContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'ResumeContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'RoutingCriteria' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'Steps', ], 'ActivationTimestamp' => [ 'shape' => 'timestamp', ], 'Index' => [ 'shape' => 'Index', ], ], ], 'RoutingCriteriaStepStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'JOINED', 'EXPIRED', ], ], 'RoutingExpression' => [ 'type' => 'string', 'max' => 3000, 'min' => 1, ], 'RoutingExpressions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingExpression', ], 'max' => 50, ], 'RoutingProfile' => [ 'type' => 'structure', 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Name' => [ 'shape' => 'RoutingProfileName', ], 'RoutingProfileArn' => [ 'shape' => 'ARN', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'Description' => [ 'shape' => 'RoutingProfileDescription', ], 'MediaConcurrencies' => [ 'shape' => 'MediaConcurrencies', ], 'DefaultOutboundQueueId' => [ 'shape' => 'QueueId', ], 'Tags' => [ 'shape' => 'TagMap', ], 'NumberOfAssociatedQueues' => [ 'shape' => 'Long', ], 'NumberOfAssociatedUsers' => [ 'shape' => 'Long', ], 'AgentAvailabilityTimer' => [ 'shape' => 'AgentAvailabilityTimer', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], 'IsDefault' => [ 'shape' => 'Boolean', ], 'AssociatedQueueIds' => [ 'shape' => 'AssociatedQueueIdList', ], ], ], 'RoutingProfileDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 1, ], 'RoutingProfileId' => [ 'type' => 'string', ], 'RoutingProfileList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfile', ], ], 'RoutingProfileName' => [ 'type' => 'string', 'max' => 127, 'min' => 1, ], 'RoutingProfileQueueConfig' => [ 'type' => 'structure', 'required' => [ 'QueueReference', 'Priority', 'Delay', ], 'members' => [ 'QueueReference' => [ 'shape' => 'RoutingProfileQueueReference', ], 'Priority' => [ 'shape' => 'Priority', 'box' => true, ], 'Delay' => [ 'shape' => 'Delay', 'box' => true, ], ], ], 'RoutingProfileQueueConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileQueueConfig', ], 'max' => 10, 'min' => 1, ], 'RoutingProfileQueueConfigSummary' => [ 'type' => 'structure', 'required' => [ 'QueueId', 'QueueArn', 'QueueName', 'Priority', 'Delay', 'Channel', ], 'members' => [ 'QueueId' => [ 'shape' => 'QueueId', ], 'QueueArn' => [ 'shape' => 'ARN', ], 'QueueName' => [ 'shape' => 'QueueName', ], 'Priority' => [ 'shape' => 'Priority', ], 'Delay' => [ 'shape' => 'Delay', ], 'Channel' => [ 'shape' => 'Channel', ], ], ], 'RoutingProfileQueueConfigSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileQueueConfigSummary', ], ], 'RoutingProfileQueueReference' => [ 'type' => 'structure', 'required' => [ 'QueueId', 'Channel', ], 'members' => [ 'QueueId' => [ 'shape' => 'QueueId', ], 'Channel' => [ 'shape' => 'Channel', ], ], ], 'RoutingProfileQueueReferenceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileQueueReference', ], ], 'RoutingProfileReference' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'RoutingProfileId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'RoutingProfileSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileSearchCriteria', ], ], 'RoutingProfileSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'RoutingProfileSearchConditionList', ], 'AndConditions' => [ 'shape' => 'RoutingProfileSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'RoutingProfileSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'RoutingProfileSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'RoutingProfileId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'RoutingProfileName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'RoutingProfileSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileSummary', ], ], 'RoutingProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingProfileId', ], 'max' => 100, 'min' => 1, ], 'Rule' => [ 'type' => 'structure', 'required' => [ 'Name', 'RuleId', 'RuleArn', 'TriggerEventSource', 'Function', 'Actions', 'PublishStatus', 'CreatedTime', 'LastUpdatedTime', 'LastUpdatedBy', ], 'members' => [ 'Name' => [ 'shape' => 'RuleName', ], 'RuleId' => [ 'shape' => 'RuleId', ], 'RuleArn' => [ 'shape' => 'ARN', ], 'TriggerEventSource' => [ 'shape' => 'RuleTriggerEventSource', ], 'Function' => [ 'shape' => 'RuleFunction', ], 'Actions' => [ 'shape' => 'RuleActions', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedBy' => [ 'shape' => 'ARN', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'RuleAction' => [ 'type' => 'structure', 'required' => [ 'ActionType', ], 'members' => [ 'ActionType' => [ 'shape' => 'ActionType', ], 'TaskAction' => [ 'shape' => 'TaskActionDefinition', ], 'EventBridgeAction' => [ 'shape' => 'EventBridgeActionDefinition', ], 'AssignContactCategoryAction' => [ 'shape' => 'AssignContactCategoryActionDefinition', ], 'SendNotificationAction' => [ 'shape' => 'SendNotificationActionDefinition', ], 'CreateCaseAction' => [ 'shape' => 'CreateCaseActionDefinition', ], 'UpdateCaseAction' => [ 'shape' => 'UpdateCaseActionDefinition', ], 'EndAssociatedTasksAction' => [ 'shape' => 'EndAssociatedTasksActionDefinition', ], 'SubmitAutoEvaluationAction' => [ 'shape' => 'SubmitAutoEvaluationActionDefinition', ], ], ], 'RuleActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleAction', ], ], 'RuleFunction' => [ 'type' => 'string', ], 'RuleId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'RuleName' => [ 'type' => 'string', 'max' => 200, 'min' => 1, 'pattern' => '^[0-9a-zA-Z._-]+', ], 'RulePublishStatus' => [ 'type' => 'string', 'enum' => [ 'DRAFT', 'PUBLISHED', ], ], 'RuleSummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'RuleId', 'RuleArn', 'EventSourceName', 'PublishStatus', 'ActionSummaries', 'CreatedTime', 'LastUpdatedTime', ], 'members' => [ 'Name' => [ 'shape' => 'RuleName', ], 'RuleId' => [ 'shape' => 'RuleId', ], 'RuleArn' => [ 'shape' => 'ARN', ], 'EventSourceName' => [ 'shape' => 'EventSourceName', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', ], 'ActionSummaries' => [ 'shape' => 'ActionSummaries', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastUpdatedTime' => [ 'shape' => 'Timestamp', ], ], ], 'RuleSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RuleSummary', ], ], 'RuleTriggerEventSource' => [ 'type' => 'structure', 'required' => [ 'EventSourceName', ], 'members' => [ 'EventSourceName' => [ 'shape' => 'EventSourceName', ], 'IntegrationAssociationId' => [ 'shape' => 'IntegrationAssociationId', ], ], ], 'S3Config' => [ 'type' => 'structure', 'required' => [ 'BucketName', 'BucketPrefix', ], 'members' => [ 'BucketName' => [ 'shape' => 'BucketName', ], 'BucketPrefix' => [ 'shape' => 'Prefix', ], 'EncryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'S3Uri' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, 'pattern' => 's3://\\S+/.+|https://\\\\S+\\\\.s3\\\\.\\\\S+\\\\.amazonaws\\\\.com/\\\\S+', ], 'SearchAvailablePhoneNumbersRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberCountryCode', 'PhoneNumberType', ], 'members' => [ 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'PhoneNumberCountryCode' => [ 'shape' => 'PhoneNumberCountryCode', ], 'PhoneNumberType' => [ 'shape' => 'PhoneNumberType', ], 'PhoneNumberPrefix' => [ 'shape' => 'PhoneNumberPrefix', ], 'MaxResults' => [ 'shape' => 'MaxResult10', 'box' => true, ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], ], ], 'SearchAvailablePhoneNumbersResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'AvailableNumbersList' => [ 'shape' => 'AvailableNumbersList', ], ], ], 'SearchContactFlowModulesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'ContactFlowModuleSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'ContactFlowModuleSearchCriteria', ], ], ], 'SearchContactFlowModulesResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlowModules' => [ 'shape' => 'ContactFlowModuleSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchContactFlowsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'ContactFlowSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'ContactFlowSearchCriteria', ], ], ], 'SearchContactFlowsResponse' => [ 'type' => 'structure', 'members' => [ 'ContactFlows' => [ 'shape' => 'ContactFlowSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchContactsMatchType' => [ 'type' => 'string', 'enum' => [ 'MATCH_ALL', 'MATCH_ANY', ], ], 'SearchContactsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'TimeRange', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'TimeRange' => [ 'shape' => 'SearchContactsTimeRange', ], 'SearchCriteria' => [ 'shape' => 'SearchCriteria', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'Sort' => [ 'shape' => 'Sort', ], ], ], 'SearchContactsResponse' => [ 'type' => 'structure', 'required' => [ 'Contacts', ], 'members' => [ 'Contacts' => [ 'shape' => 'Contacts', ], 'NextToken' => [ 'shape' => 'LargeNextToken', ], 'TotalCount' => [ 'shape' => 'TotalCount', ], ], ], 'SearchContactsTimeRange' => [ 'type' => 'structure', 'required' => [ 'Type', 'StartTime', 'EndTime', ], 'members' => [ 'Type' => [ 'shape' => 'SearchContactsTimeRangeType', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'SearchContactsTimeRangeType' => [ 'type' => 'string', 'enum' => [ 'INITIATION_TIMESTAMP', 'SCHEDULED_TIMESTAMP', 'CONNECTED_TO_AGENT_TIMESTAMP', 'DISCONNECT_TIMESTAMP', ], ], 'SearchCriteria' => [ 'type' => 'structure', 'members' => [ 'AgentIds' => [ 'shape' => 'AgentResourceIdList', ], 'AgentHierarchyGroups' => [ 'shape' => 'AgentHierarchyGroups', ], 'Channels' => [ 'shape' => 'ChannelList', ], 'ContactAnalysis' => [ 'shape' => 'ContactAnalysis', ], 'InitiationMethods' => [ 'shape' => 'InitiationMethodList', ], 'QueueIds' => [ 'shape' => 'QueueIdList', ], 'SearchableContactAttributes' => [ 'shape' => 'SearchableContactAttributes', ], ], ], 'SearchHoursOfOperationsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'HoursOfOperationSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'HoursOfOperationSearchCriteria', ], ], ], 'SearchHoursOfOperationsResponse' => [ 'type' => 'structure', 'members' => [ 'HoursOfOperations' => [ 'shape' => 'HoursOfOperationList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchPredefinedAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchCriteria' => [ 'shape' => 'PredefinedAttributeSearchCriteria', ], ], ], 'SearchPredefinedAttributesResponse' => [ 'type' => 'structure', 'members' => [ 'PredefinedAttributes' => [ 'shape' => 'PredefinedAttributeSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchPromptsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'PromptSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'PromptSearchCriteria', ], ], ], 'SearchPromptsResponse' => [ 'type' => 'structure', 'members' => [ 'Prompts' => [ 'shape' => 'PromptList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult500', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'QueueSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'QueueSearchCriteria', ], ], ], 'SearchQueuesResponse' => [ 'type' => 'structure', 'members' => [ 'Queues' => [ 'shape' => 'QueueSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchQuickConnectsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'QuickConnectSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'QuickConnectSearchCriteria', ], ], ], 'SearchQuickConnectsResponse' => [ 'type' => 'structure', 'members' => [ 'QuickConnects' => [ 'shape' => 'QuickConnectSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchResourceTagsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceIdOrArn', ], 'ResourceTypes' => [ 'shape' => 'ResourceTypeList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchCriteria' => [ 'shape' => 'ResourceTagsSearchCriteria', ], ], ], 'SearchResourceTagsResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagsList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], ], ], 'SearchRoutingProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult500', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'RoutingProfileSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'RoutingProfileSearchCriteria', ], ], ], 'SearchRoutingProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'RoutingProfiles' => [ 'shape' => 'RoutingProfileList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchSecurityProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult100', 'box' => true, ], 'SearchCriteria' => [ 'shape' => 'SecurityProfileSearchCriteria', ], 'SearchFilter' => [ 'shape' => 'SecurityProfilesSearchFilter', ], ], ], 'SearchSecurityProfilesResponse' => [ 'type' => 'structure', 'members' => [ 'SecurityProfiles' => [ 'shape' => 'SecurityProfilesSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchText' => [ 'type' => 'string', 'max' => 128, 'sensitive' => true, ], 'SearchTextList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchText', ], 'max' => 100, 'min' => 0, ], 'SearchUsersRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'MaxResults' => [ 'shape' => 'MaxResult500', 'box' => true, ], 'SearchFilter' => [ 'shape' => 'UserSearchFilter', ], 'SearchCriteria' => [ 'shape' => 'UserSearchCriteria', ], ], ], 'SearchUsersResponse' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'UserSearchSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken2500', ], 'ApproximateTotalCount' => [ 'shape' => 'ApproximateTotalCount', ], ], ], 'SearchVocabulariesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'MaxResults' => [ 'shape' => 'MaxResult100', ], 'NextToken' => [ 'shape' => 'VocabularyNextToken', ], 'State' => [ 'shape' => 'VocabularyState', ], 'NameStartsWith' => [ 'shape' => 'VocabularyName', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], ], ], 'SearchVocabulariesResponse' => [ 'type' => 'structure', 'members' => [ 'VocabularySummaryList' => [ 'shape' => 'VocabularySummaryList', ], 'NextToken' => [ 'shape' => 'VocabularyNextToken', ], ], ], 'SearchableContactAttributeKey' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'sensitive' => true, ], 'SearchableContactAttributeValue' => [ 'type' => 'string', 'max' => 100, 'min' => 0, 'sensitive' => true, ], 'SearchableContactAttributeValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchableContactAttributeValue', ], 'max' => 20, 'min' => 0, ], 'SearchableContactAttributes' => [ 'type' => 'structure', 'required' => [ 'Criteria', ], 'members' => [ 'Criteria' => [ 'shape' => 'SearchableContactAttributesCriteriaList', ], 'MatchType' => [ 'shape' => 'SearchContactsMatchType', ], ], ], 'SearchableContactAttributesCriteria' => [ 'type' => 'structure', 'required' => [ 'Key', 'Values', ], 'members' => [ 'Key' => [ 'shape' => 'SearchableContactAttributeKey', ], 'Values' => [ 'shape' => 'SearchableContactAttributeValueList', ], ], ], 'SearchableContactAttributesCriteriaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SearchableContactAttributesCriteria', ], 'max' => 15, 'min' => 0, ], 'SearchableQueueType' => [ 'type' => 'string', 'enum' => [ 'STANDARD', ], ], 'SecurityKey' => [ 'type' => 'structure', 'members' => [ 'AssociationId' => [ 'shape' => 'AssociationId', ], 'Key' => [ 'shape' => 'PEM', ], 'CreationTime' => [ 'shape' => 'timestamp', ], ], ], 'SecurityKeysList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityKey', ], ], 'SecurityProfile' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'SecurityProfileId', ], 'OrganizationResourceId' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], 'SecurityProfileName' => [ 'shape' => 'SecurityProfileName', ], 'Description' => [ 'shape' => 'SecurityProfileDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], 'AllowedAccessControlTags' => [ 'shape' => 'AllowedAccessControlTags', ], 'TagRestrictedResources' => [ 'shape' => 'TagRestrictedResourceList', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], 'HierarchyRestrictedResources' => [ 'shape' => 'HierarchyRestrictedResourceList', ], 'AllowedAccessControlHierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], ], ], 'SecurityProfileDescription' => [ 'type' => 'string', 'max' => 250, ], 'SecurityProfileId' => [ 'type' => 'string', ], 'SecurityProfileIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfileId', ], 'max' => 10, 'min' => 1, ], 'SecurityProfileName' => [ 'type' => 'string', ], 'SecurityProfilePermission' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'SecurityProfilePolicyKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'SecurityProfilePolicyValue' => [ 'type' => 'string', 'max' => 256, ], 'SecurityProfileSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfileSearchCriteria', ], ], 'SecurityProfileSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'SecurityProfileSearchConditionList', ], 'AndConditions' => [ 'shape' => 'SecurityProfileSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], ], ], 'SecurityProfileSearchSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'SecurityProfileId', ], 'OrganizationResourceId' => [ 'shape' => 'InstanceId', ], 'Arn' => [ 'shape' => 'ARN', ], 'SecurityProfileName' => [ 'shape' => 'SecurityProfileName', ], 'Description' => [ 'shape' => 'SecurityProfileDescription', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'SecurityProfileSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'SecurityProfileId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'SecurityProfileName', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'SecurityProfileSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfileSummary', ], ], 'SecurityProfilesSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], ], ], 'SecurityProfilesSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityProfileSearchSummary', ], ], 'SecurityToken' => [ 'type' => 'string', 'sensitive' => true, ], 'SegmentAttributeName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'SegmentAttributeValue' => [ 'type' => 'structure', 'members' => [ 'ValueString' => [ 'shape' => 'SegmentAttributeValueString', ], ], ], 'SegmentAttributeValueString' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'SegmentAttributes' => [ 'type' => 'map', 'key' => [ 'shape' => 'SegmentAttributeName', ], 'value' => [ 'shape' => 'SegmentAttributeValue', ], ], 'SendChatIntegrationEventRequest' => [ 'type' => 'structure', 'required' => [ 'SourceId', 'DestinationId', 'Event', ], 'members' => [ 'SourceId' => [ 'shape' => 'SourceId', ], 'DestinationId' => [ 'shape' => 'DestinationId', ], 'Subtype' => [ 'shape' => 'Subtype', ], 'Event' => [ 'shape' => 'ChatEvent', ], 'NewSessionDetails' => [ 'shape' => 'NewSessionDetails', ], ], ], 'SendChatIntegrationEventResponse' => [ 'type' => 'structure', 'members' => [ 'InitialContactId' => [ 'shape' => 'ContactId', ], 'NewChatCreated' => [ 'shape' => 'NewChatCreated', ], ], ], 'SendNotificationActionDefinition' => [ 'type' => 'structure', 'required' => [ 'DeliveryMethod', 'Content', 'ContentType', 'Recipient', ], 'members' => [ 'DeliveryMethod' => [ 'shape' => 'NotificationDeliveryType', ], 'Subject' => [ 'shape' => 'Subject', ], 'Content' => [ 'shape' => 'Content', ], 'ContentType' => [ 'shape' => 'NotificationContentType', ], 'Recipient' => [ 'shape' => 'NotificationRecipientType', ], ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 402, ], 'exception' => true, ], 'SignInConfig' => [ 'type' => 'structure', 'required' => [ 'Distributions', ], 'members' => [ 'Distributions' => [ 'shape' => 'SignInDistributionList', ], ], ], 'SignInDistribution' => [ 'type' => 'structure', 'required' => [ 'Region', 'Enabled', ], 'members' => [ 'Region' => [ 'shape' => 'AwsRegion', ], 'Enabled' => [ 'shape' => 'Boolean', ], ], ], 'SignInDistributionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SignInDistribution', ], ], 'SingleSelectOptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskTemplateSingleSelectOption', ], ], 'SingleSelectQuestionRuleCategoryAutomation' => [ 'type' => 'structure', 'required' => [ 'Category', 'Condition', 'OptionRefId', ], 'members' => [ 'Category' => [ 'shape' => 'SingleSelectQuestionRuleCategoryAutomationLabel', ], 'Condition' => [ 'shape' => 'SingleSelectQuestionRuleCategoryAutomationCondition', ], 'OptionRefId' => [ 'shape' => 'ReferenceId', ], ], ], 'SingleSelectQuestionRuleCategoryAutomationCondition' => [ 'type' => 'string', 'enum' => [ 'PRESENT', 'NOT_PRESENT', ], ], 'SingleSelectQuestionRuleCategoryAutomationLabel' => [ 'type' => 'string', 'max' => 50, 'min' => 1, ], 'SnapshotVersion' => [ 'type' => 'string', ], 'Sort' => [ 'type' => 'structure', 'required' => [ 'FieldName', 'Order', ], 'members' => [ 'FieldName' => [ 'shape' => 'SortableFieldName', ], 'Order' => [ 'shape' => 'SortOrder', ], ], ], 'SortOrder' => [ 'type' => 'string', 'enum' => [ 'ASCENDING', 'DESCENDING', ], ], 'SortableFieldName' => [ 'type' => 'string', 'enum' => [ 'INITIATION_TIMESTAMP', 'SCHEDULED_TIMESTAMP', 'CONNECTED_TO_AGENT_TIMESTAMP', 'DISCONNECT_TIMESTAMP', 'INITIATION_METHOD', 'CHANNEL', ], ], 'SourceApplicationName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9_ -]+$', ], 'SourceId' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'SALESFORCE', 'ZENDESK', 'CASES', ], ], 'StartAttachedFileUploadRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'FileName', 'FileSizeInBytes', 'FileUseCaseType', 'AssociatedResourceArn', ], 'members' => [ 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'FileName' => [ 'shape' => 'FileName', ], 'FileSizeInBytes' => [ 'shape' => 'FileSizeInBytes', 'box' => true, ], 'UrlExpiryInSeconds' => [ 'shape' => 'URLExpiryInSeconds', ], 'FileUseCaseType' => [ 'shape' => 'FileUseCaseType', ], 'AssociatedResourceArn' => [ 'shape' => 'ARN', 'location' => 'querystring', 'locationName' => 'associatedResourceArn', ], 'CreatedBy' => [ 'shape' => 'CreatedByInfo', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'StartAttachedFileUploadResponse' => [ 'type' => 'structure', 'members' => [ 'FileArn' => [ 'shape' => 'ARN', ], 'FileId' => [ 'shape' => 'FileId', ], 'CreationTime' => [ 'shape' => 'ISO8601Datetime', ], 'FileStatus' => [ 'shape' => 'FileStatusType', ], 'CreatedBy' => [ 'shape' => 'CreatedByInfo', ], 'UploadUrlMetadata' => [ 'shape' => 'UploadUrlMetadata', ], ], ], 'StartChatContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', 'ParticipantDetails', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'ParticipantDetails' => [ 'shape' => 'ParticipantDetails', ], 'InitialMessage' => [ 'shape' => 'ChatMessage', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ChatDurationInMinutes' => [ 'shape' => 'ChatDurationInMinutes', ], 'SupportedMessagingContentTypes' => [ 'shape' => 'SupportedMessagingContentTypes', ], 'PersistentChat' => [ 'shape' => 'PersistentChat', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], 'SegmentAttributes' => [ 'shape' => 'SegmentAttributes', ], ], ], 'StartChatContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantToken' => [ 'shape' => 'ParticipantToken', ], 'ContinuedFromContactId' => [ 'shape' => 'ContactId', ], ], ], 'StartContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'EvaluationFormId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'StartContactEvaluationResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], ], ], 'StartContactRecordingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'InitialContactId', 'VoiceRecordingConfiguration', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], 'VoiceRecordingConfiguration' => [ 'shape' => 'VoiceRecordingConfiguration', ], ], ], 'StartContactRecordingResponse' => [ 'type' => 'structure', 'members' => [], ], 'StartContactStreamingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ChatStreamingConfiguration', 'ClientToken', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'ChatStreamingConfiguration' => [ 'shape' => 'ChatStreamingConfiguration', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'StartContactStreamingResponse' => [ 'type' => 'structure', 'required' => [ 'StreamingId', ], 'members' => [ 'StreamingId' => [ 'shape' => 'StreamingId', ], ], ], 'StartOutboundVoiceContactRequest' => [ 'type' => 'structure', 'required' => [ 'DestinationPhoneNumber', 'ContactFlowId', 'InstanceId', ], 'members' => [ 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'References' => [ 'shape' => 'ContactReferences', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], 'DestinationPhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'SourcePhoneNumber' => [ 'shape' => 'PhoneNumber', ], 'QueueId' => [ 'shape' => 'QueueId', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'AnswerMachineDetectionConfig' => [ 'shape' => 'AnswerMachineDetectionConfig', ], 'CampaignId' => [ 'shape' => 'CampaignId', ], 'TrafficType' => [ 'shape' => 'TrafficType', ], ], ], 'StartOutboundVoiceContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], ], ], 'StartTaskContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'PreviousContactId' => [ 'shape' => 'ContactId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Attributes' => [ 'shape' => 'Attributes', ], 'Name' => [ 'shape' => 'Name', ], 'References' => [ 'shape' => 'ContactReferences', ], 'Description' => [ 'shape' => 'Description', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], 'TaskTemplateId' => [ 'shape' => 'TaskTemplateId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], ], ], 'StartTaskContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], ], ], 'StartWebRTCContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactFlowId', 'InstanceId', 'ParticipantDetails', ], 'members' => [ 'Attributes' => [ 'shape' => 'Attributes', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'AllowedCapabilities' => [ 'shape' => 'AllowedCapabilities', ], 'ParticipantDetails' => [ 'shape' => 'ParticipantDetails', ], 'RelatedContactId' => [ 'shape' => 'ContactId', ], 'References' => [ 'shape' => 'ContactReferences', ], 'Description' => [ 'shape' => 'Description', ], ], ], 'StartWebRTCContactResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectionData' => [ 'shape' => 'ConnectionData', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'ParticipantId' => [ 'shape' => 'ParticipantId', ], 'ParticipantToken' => [ 'shape' => 'ParticipantToken', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'SUM', 'MAX', 'AVG', ], ], 'Step' => [ 'type' => 'structure', 'members' => [ 'Expiry' => [ 'shape' => 'Expiry', ], 'Expression' => [ 'shape' => 'Expression', ], 'Status' => [ 'shape' => 'RoutingCriteriaStepStatus', ], ], ], 'Steps' => [ 'type' => 'list', 'member' => [ 'shape' => 'Step', ], ], 'StopContactRecordingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'InitialContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], ], ], 'StopContactRecordingResponse' => [ 'type' => 'structure', 'members' => [], ], 'StopContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'DisconnectReason' => [ 'shape' => 'DisconnectReason', ], ], ], 'StopContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'StopContactStreamingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'StreamingId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'StreamingId' => [ 'shape' => 'StreamingId', ], ], ], 'StopContactStreamingResponse' => [ 'type' => 'structure', 'members' => [], ], 'StorageType' => [ 'type' => 'string', 'enum' => [ 'S3', 'KINESIS_VIDEO_STREAM', 'KINESIS_STREAM', 'KINESIS_FIREHOSE', ], ], 'StreamingId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'String' => [ 'type' => 'string', ], 'StringComparisonType' => [ 'type' => 'string', 'enum' => [ 'STARTS_WITH', 'CONTAINS', 'EXACT', ], ], 'StringCondition' => [ 'type' => 'structure', 'members' => [ 'FieldName' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], 'ComparisonType' => [ 'shape' => 'StringComparisonType', ], ], ], 'StringReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'Subject' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'SubmitAutoEvaluationActionDefinition' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'EvaluationFormId', ], ], ], 'SubmitContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationId', ], 'Answers' => [ 'shape' => 'EvaluationAnswersInputMap', ], 'Notes' => [ 'shape' => 'EvaluationNotesMap', ], ], ], 'SubmitContactEvaluationResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], ], ], 'Subtype' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'SuccessfulRequest' => [ 'type' => 'structure', 'members' => [ 'RequestIdentifier' => [ 'shape' => 'RequestIdentifier', ], 'ContactId' => [ 'shape' => 'ContactId', ], ], ], 'SuccessfulRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuccessfulRequest', ], ], 'SupportedMessagingContentType' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'SupportedMessagingContentTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'SupportedMessagingContentType', ], ], 'SuspendContactRecordingRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'InitialContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'InitialContactId' => [ 'shape' => 'ContactId', ], ], ], 'SuspendContactRecordingResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagAndConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagCondition', ], ], 'TagCondition' => [ 'type' => 'structure', 'members' => [ 'TagKey' => [ 'shape' => 'String', ], 'TagValue' => [ 'shape' => 'String', ], ], ], 'TagContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', 'Tags', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Tags' => [ 'shape' => 'ContactTagMap', ], ], ], 'TagContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^(?!aws:)[a-zA-Z+-=._:/]+$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 1, ], 'TagKeyString' => [ 'type' => 'string', 'max' => 128, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 50, 'min' => 1, ], 'TagOrConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagAndConditionList', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagRestrictedResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagRestrictedResourceName', ], 'max' => 10, ], 'TagRestrictedResourceName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagSearchCondition' => [ 'type' => 'structure', 'members' => [ 'tagKey' => [ 'shape' => 'TagKeyString', ], 'tagValue' => [ 'shape' => 'TagValueString', ], 'tagKeyComparisonType' => [ 'shape' => 'StringComparisonType', ], 'tagValueComparisonType' => [ 'shape' => 'StringComparisonType', ], ], ], 'TagSet' => [ 'type' => 'structure', 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, ], 'TagValueString' => [ 'type' => 'string', 'max' => 256, ], 'TagsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagSet', ], ], 'TaskActionDefinition' => [ 'type' => 'structure', 'required' => [ 'Name', 'ContactFlowId', ], 'members' => [ 'Name' => [ 'shape' => 'TaskNameExpression', ], 'Description' => [ 'shape' => 'TaskDescriptionExpression', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'References' => [ 'shape' => 'ContactReferences', ], ], ], 'TaskDescriptionExpression' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, ], 'TaskNameExpression' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'TaskTemplateArn' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'TaskTemplateConstraints' => [ 'type' => 'structure', 'members' => [ 'RequiredFields' => [ 'shape' => 'RequiredTaskTemplateFields', ], 'ReadOnlyFields' => [ 'shape' => 'ReadOnlyTaskTemplateFields', ], 'InvisibleFields' => [ 'shape' => 'InvisibleTaskTemplateFields', ], ], ], 'TaskTemplateDefaultFieldValue' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], 'DefaultValue' => [ 'shape' => 'TaskTemplateFieldValue', ], ], ], 'TaskTemplateDefaultFieldValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskTemplateDefaultFieldValue', ], ], 'TaskTemplateDefaults' => [ 'type' => 'structure', 'members' => [ 'DefaultFieldValues' => [ 'shape' => 'TaskTemplateDefaultFieldValueList', ], ], ], 'TaskTemplateDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'TaskTemplateField' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateFieldIdentifier', ], 'Description' => [ 'shape' => 'TaskTemplateFieldDescription', ], 'Type' => [ 'shape' => 'TaskTemplateFieldType', ], 'SingleSelectOptions' => [ 'shape' => 'SingleSelectOptions', ], ], ], 'TaskTemplateFieldDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'TaskTemplateFieldIdentifier' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'TaskTemplateFieldName', ], ], ], 'TaskTemplateFieldName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'TaskTemplateFieldType' => [ 'type' => 'string', 'enum' => [ 'NAME', 'DESCRIPTION', 'SCHEDULED_TIME', 'QUICK_CONNECT', 'URL', 'NUMBER', 'TEXT', 'TEXT_AREA', 'DATE_TIME', 'BOOLEAN', 'SINGLE_SELECT', 'EMAIL', ], ], 'TaskTemplateFieldValue' => [ 'type' => 'string', 'max' => 4096, 'min' => 0, ], 'TaskTemplateFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskTemplateField', ], ], 'TaskTemplateId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'TaskTemplateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TaskTemplateMetadata', ], ], 'TaskTemplateMetadata' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TaskTemplateId', ], 'Arn' => [ 'shape' => 'TaskTemplateArn', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'LastModifiedTime' => [ 'shape' => 'timestamp', ], 'CreatedTime' => [ 'shape' => 'timestamp', ], ], ], 'TaskTemplateName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'TaskTemplateSingleSelectOption' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'TaskTemplateStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', ], ], 'TelephonyConfig' => [ 'type' => 'structure', 'required' => [ 'Distributions', ], 'members' => [ 'Distributions' => [ 'shape' => 'DistributionList', ], ], ], 'TemplateId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'Threshold' => [ 'type' => 'structure', 'members' => [ 'Comparison' => [ 'shape' => 'Comparison', ], 'ThresholdValue' => [ 'shape' => 'ThresholdValue', 'box' => true, ], ], ], 'ThresholdCollections' => [ 'type' => 'list', 'member' => [ 'shape' => 'ThresholdV2', ], 'max' => 1, ], 'ThresholdV2' => [ 'type' => 'structure', 'members' => [ 'Comparison' => [ 'shape' => 'ResourceArnOrId', ], 'ThresholdValue' => [ 'shape' => 'ThresholdValue', 'box' => true, ], ], ], 'ThresholdValue' => [ 'type' => 'double', ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TimeZone' => [ 'type' => 'string', ], 'TimerEligibleParticipantRoles' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER', 'AGENT', ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooManyRequestsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TotalCount' => [ 'type' => 'long', ], 'TotalPauseCount' => [ 'type' => 'integer', 'max' => 10, 'min' => 0, ], 'TotalPauseDurationInSeconds' => [ 'type' => 'integer', 'min' => 0, ], 'TrafficDistributionGroup' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupId', ], 'Arn' => [ 'shape' => 'TrafficDistributionGroupArn', ], 'Name' => [ 'shape' => 'Name128', ], 'Description' => [ 'shape' => 'Description250', ], 'InstanceArn' => [ 'shape' => 'InstanceArn', ], 'Status' => [ 'shape' => 'TrafficDistributionGroupStatus', ], 'Tags' => [ 'shape' => 'TagMap', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'TrafficDistributionGroupArn' => [ 'type' => 'string', 'pattern' => '^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'TrafficDistributionGroupId' => [ 'type' => 'string', 'pattern' => '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'TrafficDistributionGroupIdOrArn' => [ 'type' => 'string', 'pattern' => '^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'TrafficDistributionGroupStatus' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'ACTIVE', 'CREATION_FAILED', 'PENDING_DELETION', 'DELETION_FAILED', 'UPDATE_IN_PROGRESS', ], ], 'TrafficDistributionGroupSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupId', ], 'Arn' => [ 'shape' => 'TrafficDistributionGroupArn', ], 'Name' => [ 'shape' => 'Name128', ], 'InstanceArn' => [ 'shape' => 'InstanceArn', ], 'Status' => [ 'shape' => 'TrafficDistributionGroupStatus', ], 'IsDefault' => [ 'shape' => 'Boolean', ], ], ], 'TrafficDistributionGroupSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrafficDistributionGroupSummary', ], 'max' => 10, 'min' => 0, ], 'TrafficDistributionGroupUserSummary' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], ], ], 'TrafficDistributionGroupUserSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TrafficDistributionGroupUserSummary', ], 'max' => 10, 'min' => 0, ], 'TrafficType' => [ 'type' => 'string', 'enum' => [ 'GENERAL', 'CAMPAIGN', ], ], 'Transcript' => [ 'type' => 'structure', 'required' => [ 'Criteria', ], 'members' => [ 'Criteria' => [ 'shape' => 'TranscriptCriteriaList', ], 'MatchType' => [ 'shape' => 'SearchContactsMatchType', ], ], ], 'TranscriptCriteria' => [ 'type' => 'structure', 'required' => [ 'ParticipantRole', 'SearchText', 'MatchType', ], 'members' => [ 'ParticipantRole' => [ 'shape' => 'ParticipantRole', ], 'SearchText' => [ 'shape' => 'SearchTextList', ], 'MatchType' => [ 'shape' => 'SearchContactsMatchType', ], ], ], 'TranscriptCriteriaList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TranscriptCriteria', ], 'max' => 6, 'min' => 0, ], 'TransferContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'QueueId' => [ 'shape' => 'QueueId', ], 'UserId' => [ 'shape' => 'AgentResourceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'TransferContactResponse' => [ 'type' => 'structure', 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', ], 'ContactArn' => [ 'shape' => 'ARN', ], ], ], 'URI' => [ 'type' => 'string', 'max' => 2000, 'min' => 1, ], 'URLExpiryInSeconds' => [ 'type' => 'integer', 'max' => 300, 'min' => 5, ], 'Unit' => [ 'type' => 'string', 'enum' => [ 'SECONDS', 'COUNT', 'PERCENT', ], ], 'UntagContactRequest' => [ 'type' => 'structure', 'required' => [ 'ContactId', 'InstanceId', 'TagKeys', ], 'members' => [ 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'TagKeys' => [ 'shape' => 'ContactTagKeys', 'location' => 'querystring', 'locationName' => 'TagKeys', ], ], ], 'UntagContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ARN', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UpdateAgentStatusDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 0, ], 'UpdateAgentStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AgentStatusId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AgentStatusId' => [ 'shape' => 'AgentStatusId', 'location' => 'uri', 'locationName' => 'AgentStatusId', ], 'Name' => [ 'shape' => 'AgentStatusName', ], 'Description' => [ 'shape' => 'UpdateAgentStatusDescription', ], 'State' => [ 'shape' => 'AgentStatusState', ], 'DisplayOrder' => [ 'shape' => 'AgentStatusOrderNumber', 'box' => true, ], 'ResetOrderNumber' => [ 'shape' => 'Boolean', ], ], ], 'UpdateCaseActionDefinition' => [ 'type' => 'structure', 'required' => [ 'Fields', ], 'members' => [ 'Fields' => [ 'shape' => 'FieldValues', ], ], ], 'UpdateContactAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'InitialContactId', 'InstanceId', 'Attributes', ], 'members' => [ 'InitialContactId' => [ 'shape' => 'ContactId', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Attributes' => [ 'shape' => 'Attributes', ], ], ], 'UpdateContactAttributesResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactEvaluationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationId', ], 'Answers' => [ 'shape' => 'EvaluationAnswersInputMap', ], 'Notes' => [ 'shape' => 'EvaluationNotesMap', ], ], ], 'UpdateContactEvaluationResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationId', 'EvaluationArn', ], 'members' => [ 'EvaluationId' => [ 'shape' => 'ResourceId', ], 'EvaluationArn' => [ 'shape' => 'ARN', ], ], ], 'UpdateContactFlowContentRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], 'Content' => [ 'shape' => 'ContactFlowContent', ], ], ], 'UpdateContactFlowContentResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactFlowMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'Description' => [ 'shape' => 'ContactFlowDescription', ], 'ContactFlowState' => [ 'shape' => 'ContactFlowState', ], ], ], 'UpdateContactFlowMetadataResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactFlowModuleContentRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowModuleId', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowModuleId' => [ 'shape' => 'ContactFlowModuleId', 'location' => 'uri', 'locationName' => 'ContactFlowModuleId', ], 'Content' => [ 'shape' => 'ContactFlowModuleContent', ], ], ], 'UpdateContactFlowModuleContentResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactFlowModuleMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowModuleId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowModuleId' => [ 'shape' => 'ContactFlowModuleId', 'location' => 'uri', 'locationName' => 'ContactFlowModuleId', ], 'Name' => [ 'shape' => 'ContactFlowModuleName', ], 'Description' => [ 'shape' => 'ContactFlowModuleDescription', ], 'State' => [ 'shape' => 'ContactFlowModuleState', ], ], ], 'UpdateContactFlowModuleMetadataResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactFlowNameRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactFlowId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', 'location' => 'uri', 'locationName' => 'ContactFlowId', ], 'Name' => [ 'shape' => 'ContactFlowName', ], 'Description' => [ 'shape' => 'ContactFlowDescription', ], ], ], 'UpdateContactFlowNameResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'Name' => [ 'shape' => 'Name', ], 'Description' => [ 'shape' => 'Description', ], 'References' => [ 'shape' => 'ContactReferences', ], ], ], 'UpdateContactResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactRoutingDataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'QueueTimeAdjustmentSeconds' => [ 'shape' => 'QueueTimeAdjustmentSeconds', ], 'QueuePriority' => [ 'shape' => 'QueuePriority', ], ], ], 'UpdateContactRoutingDataResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateContactScheduleRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ScheduledTime', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', ], 'ScheduledTime' => [ 'shape' => 'Timestamp', ], ], ], 'UpdateContactScheduleResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateEvaluationFormRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'EvaluationFormId', 'EvaluationFormVersion', 'Title', 'Items', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'EvaluationFormId' => [ 'shape' => 'ResourceId', 'location' => 'uri', 'locationName' => 'EvaluationFormId', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], 'CreateNewVersion' => [ 'shape' => 'BoxedBoolean', 'box' => true, ], 'Title' => [ 'shape' => 'EvaluationFormTitle', ], 'Description' => [ 'shape' => 'EvaluationFormDescription', ], 'Items' => [ 'shape' => 'EvaluationFormItemsList', ], 'ScoringStrategy' => [ 'shape' => 'EvaluationFormScoringStrategy', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'UpdateEvaluationFormResponse' => [ 'type' => 'structure', 'required' => [ 'EvaluationFormId', 'EvaluationFormArn', 'EvaluationFormVersion', ], 'members' => [ 'EvaluationFormId' => [ 'shape' => 'ResourceId', ], 'EvaluationFormArn' => [ 'shape' => 'ARN', ], 'EvaluationFormVersion' => [ 'shape' => 'VersionNumber', ], ], ], 'UpdateHoursOfOperationDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 0, ], 'UpdateHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', 'location' => 'uri', 'locationName' => 'HoursOfOperationId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'UpdateHoursOfOperationDescription', ], 'TimeZone' => [ 'shape' => 'TimeZone', ], 'Config' => [ 'shape' => 'HoursOfOperationConfigList', ], ], ], 'UpdateInstanceAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AttributeType', 'Value', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AttributeType' => [ 'shape' => 'InstanceAttributeType', 'location' => 'uri', 'locationName' => 'AttributeType', ], 'Value' => [ 'shape' => 'InstanceAttributeValue', ], ], ], 'UpdateInstanceStorageConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'AssociationId', 'ResourceType', 'StorageConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AssociationId' => [ 'shape' => 'AssociationId', 'location' => 'uri', 'locationName' => 'AssociationId', ], 'ResourceType' => [ 'shape' => 'InstanceStorageResourceType', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'StorageConfig' => [ 'shape' => 'InstanceStorageConfig', ], ], ], 'UpdateParticipantRoleConfigChannelInfo' => [ 'type' => 'structure', 'members' => [ 'Chat' => [ 'shape' => 'ChatParticipantRoleConfig', ], ], 'union' => true, ], 'UpdateParticipantRoleConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ContactId', 'ChannelConfiguration', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ContactId' => [ 'shape' => 'ContactId', 'location' => 'uri', 'locationName' => 'ContactId', ], 'ChannelConfiguration' => [ 'shape' => 'UpdateParticipantRoleConfigChannelInfo', ], ], ], 'UpdateParticipantRoleConfigResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePhoneNumberMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'PhoneNumberDescription' => [ 'shape' => 'PhoneNumberDescription', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'UpdatePhoneNumberRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneNumberId', ], 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', 'location' => 'uri', 'locationName' => 'PhoneNumberId', ], 'TargetArn' => [ 'shape' => 'ARN', ], 'InstanceId' => [ 'shape' => 'InstanceId', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'UpdatePhoneNumberResponse' => [ 'type' => 'structure', 'members' => [ 'PhoneNumberId' => [ 'shape' => 'PhoneNumberId', ], 'PhoneNumberArn' => [ 'shape' => 'ARN', ], ], ], 'UpdatePredefinedAttributeRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'Name', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'PredefinedAttributeName', 'location' => 'uri', 'locationName' => 'Name', ], 'Values' => [ 'shape' => 'PredefinedAttributeValues', ], ], ], 'UpdatePromptRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'PromptId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'PromptId' => [ 'shape' => 'PromptId', 'location' => 'uri', 'locationName' => 'PromptId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'PromptDescription', ], 'S3Uri' => [ 'shape' => 'S3Uri', ], ], ], 'UpdatePromptResponse' => [ 'type' => 'structure', 'members' => [ 'PromptARN' => [ 'shape' => 'ARN', ], 'PromptId' => [ 'shape' => 'PromptId', ], ], ], 'UpdateQueueHoursOfOperationRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'HoursOfOperationId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'HoursOfOperationId' => [ 'shape' => 'HoursOfOperationId', ], ], ], 'UpdateQueueMaxContactsRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'MaxContacts' => [ 'shape' => 'QueueMaxContacts', 'box' => true, ], ], ], 'UpdateQueueNameRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'Name' => [ 'shape' => 'CommonNameLength127', ], 'Description' => [ 'shape' => 'QueueDescription', ], ], ], 'UpdateQueueOutboundCallerConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'OutboundCallerConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'OutboundCallerConfig' => [ 'shape' => 'OutboundCallerConfig', ], ], ], 'UpdateQueueStatusRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QueueId', 'Status', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QueueId' => [ 'shape' => 'QueueId', 'location' => 'uri', 'locationName' => 'QueueId', ], 'Status' => [ 'shape' => 'QueueStatus', ], ], ], 'UpdateQuickConnectConfigRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QuickConnectId', 'QuickConnectConfig', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', 'location' => 'uri', 'locationName' => 'QuickConnectId', ], 'QuickConnectConfig' => [ 'shape' => 'QuickConnectConfig', ], ], ], 'UpdateQuickConnectDescription' => [ 'type' => 'string', 'max' => 250, 'min' => 0, ], 'UpdateQuickConnectNameRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'QuickConnectId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'QuickConnectId' => [ 'shape' => 'QuickConnectId', 'location' => 'uri', 'locationName' => 'QuickConnectId', ], 'Name' => [ 'shape' => 'QuickConnectName', ], 'Description' => [ 'shape' => 'UpdateQuickConnectDescription', ], ], ], 'UpdateRoutingProfileAgentAvailabilityTimerRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'AgentAvailabilityTimer', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'AgentAvailabilityTimer' => [ 'shape' => 'AgentAvailabilityTimer', ], ], ], 'UpdateRoutingProfileConcurrencyRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'MediaConcurrencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'MediaConcurrencies' => [ 'shape' => 'MediaConcurrencies', ], ], ], 'UpdateRoutingProfileDefaultOutboundQueueRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'DefaultOutboundQueueId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'DefaultOutboundQueueId' => [ 'shape' => 'QueueId', ], ], ], 'UpdateRoutingProfileNameRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'Name' => [ 'shape' => 'RoutingProfileName', ], 'Description' => [ 'shape' => 'RoutingProfileDescription', ], ], ], 'UpdateRoutingProfileQueuesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'RoutingProfileId', 'QueueConfigs', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', 'location' => 'uri', 'locationName' => 'RoutingProfileId', ], 'QueueConfigs' => [ 'shape' => 'RoutingProfileQueueConfigList', ], ], ], 'UpdateRuleRequest' => [ 'type' => 'structure', 'required' => [ 'RuleId', 'InstanceId', 'Name', 'Function', 'Actions', 'PublishStatus', ], 'members' => [ 'RuleId' => [ 'shape' => 'RuleId', 'location' => 'uri', 'locationName' => 'RuleId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'RuleName', ], 'Function' => [ 'shape' => 'RuleFunction', ], 'Actions' => [ 'shape' => 'RuleActions', ], 'PublishStatus' => [ 'shape' => 'RulePublishStatus', ], ], ], 'UpdateSecurityProfileRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileId', 'InstanceId', ], 'members' => [ 'Description' => [ 'shape' => 'SecurityProfileDescription', ], 'Permissions' => [ 'shape' => 'PermissionsList', ], 'SecurityProfileId' => [ 'shape' => 'SecurityProfileId', 'location' => 'uri', 'locationName' => 'SecurityProfileId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'AllowedAccessControlTags' => [ 'shape' => 'AllowedAccessControlTags', ], 'TagRestrictedResources' => [ 'shape' => 'TagRestrictedResourceList', ], 'Applications' => [ 'shape' => 'Applications', ], 'HierarchyRestrictedResources' => [ 'shape' => 'HierarchyRestrictedResourceList', ], 'AllowedAccessControlHierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], ], ], 'UpdateTaskTemplateRequest' => [ 'type' => 'structure', 'required' => [ 'TaskTemplateId', 'InstanceId', ], 'members' => [ 'TaskTemplateId' => [ 'shape' => 'TaskTemplateId', 'location' => 'uri', 'locationName' => 'TaskTemplateId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Constraints' => [ 'shape' => 'TaskTemplateConstraints', ], 'Defaults' => [ 'shape' => 'TaskTemplateDefaults', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'Fields' => [ 'shape' => 'TaskTemplateFields', ], ], ], 'UpdateTaskTemplateResponse' => [ 'type' => 'structure', 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', ], 'Id' => [ 'shape' => 'TaskTemplateId', ], 'Arn' => [ 'shape' => 'TaskTemplateArn', ], 'Name' => [ 'shape' => 'TaskTemplateName', ], 'Description' => [ 'shape' => 'TaskTemplateDescription', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], 'Constraints' => [ 'shape' => 'TaskTemplateConstraints', ], 'Defaults' => [ 'shape' => 'TaskTemplateDefaults', ], 'Fields' => [ 'shape' => 'TaskTemplateFields', ], 'Status' => [ 'shape' => 'TaskTemplateStatus', ], 'LastModifiedTime' => [ 'shape' => 'timestamp', ], 'CreatedTime' => [ 'shape' => 'timestamp', ], ], ], 'UpdateTrafficDistributionRequest' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'TrafficDistributionGroupIdOrArn', 'location' => 'uri', 'locationName' => 'Id', ], 'TelephonyConfig' => [ 'shape' => 'TelephonyConfig', ], 'SignInConfig' => [ 'shape' => 'SignInConfig', ], 'AgentConfig' => [ 'shape' => 'AgentConfig', ], ], ], 'UpdateTrafficDistributionResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateUserHierarchyGroupNameRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'HierarchyGroupId', 'InstanceId', ], 'members' => [ 'Name' => [ 'shape' => 'HierarchyGroupName', ], 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', 'location' => 'uri', 'locationName' => 'HierarchyGroupId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserHierarchyRequest' => [ 'type' => 'structure', 'required' => [ 'UserId', 'InstanceId', ], 'members' => [ 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserHierarchyStructureRequest' => [ 'type' => 'structure', 'required' => [ 'HierarchyStructure', 'InstanceId', ], 'members' => [ 'HierarchyStructure' => [ 'shape' => 'HierarchyStructureUpdate', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserIdentityInfoRequest' => [ 'type' => 'structure', 'required' => [ 'IdentityInfo', 'UserId', 'InstanceId', ], 'members' => [ 'IdentityInfo' => [ 'shape' => 'UserIdentityInfo', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserPhoneConfigRequest' => [ 'type' => 'structure', 'required' => [ 'PhoneConfig', 'UserId', 'InstanceId', ], 'members' => [ 'PhoneConfig' => [ 'shape' => 'UserPhoneConfig', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserProficienciesRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'UserId', 'UserProficiencies', ], 'members' => [ 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'UserProficiencies' => [ 'shape' => 'UserProficiencyList', ], ], ], 'UpdateUserRoutingProfileRequest' => [ 'type' => 'structure', 'required' => [ 'RoutingProfileId', 'UserId', 'InstanceId', ], 'members' => [ 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateUserSecurityProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'SecurityProfileIds', 'UserId', 'InstanceId', ], 'members' => [ 'SecurityProfileIds' => [ 'shape' => 'SecurityProfileIds', ], 'UserId' => [ 'shape' => 'UserId', 'location' => 'uri', 'locationName' => 'UserId', ], 'InstanceId' => [ 'shape' => 'InstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], ], ], 'UpdateViewContentRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', 'Status', 'Content', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'Status' => [ 'shape' => 'ViewStatus', ], 'Content' => [ 'shape' => 'ViewInputContent', ], ], ], 'UpdateViewContentResponse' => [ 'type' => 'structure', 'members' => [ 'View' => [ 'shape' => 'View', ], ], ], 'UpdateViewMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'InstanceId', 'ViewId', ], 'members' => [ 'InstanceId' => [ 'shape' => 'ViewsInstanceId', 'location' => 'uri', 'locationName' => 'InstanceId', ], 'ViewId' => [ 'shape' => 'ViewId', 'location' => 'uri', 'locationName' => 'ViewId', ], 'Name' => [ 'shape' => 'ViewName', ], 'Description' => [ 'shape' => 'ViewDescription', ], ], ], 'UpdateViewMetadataResponse' => [ 'type' => 'structure', 'members' => [], ], 'UploadUrlMetadata' => [ 'type' => 'structure', 'members' => [ 'Url' => [ 'shape' => 'MetadataUrl', ], 'UrlExpiry' => [ 'shape' => 'ISO8601Datetime', ], 'HeadersToInclude' => [ 'shape' => 'UrlMetadataSignedHeaders', ], ], ], 'Url' => [ 'type' => 'string', ], 'UrlMetadataSignedHeaders' => [ 'type' => 'map', 'key' => [ 'shape' => 'UrlMetadataSignedHeadersKey', ], 'value' => [ 'shape' => 'UrlMetadataSignedHeadersValue', ], ], 'UrlMetadataSignedHeadersKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'UrlMetadataSignedHeadersValue' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'UrlReference' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ReferenceKey', ], 'Value' => [ 'shape' => 'ReferenceValue', ], ], ], 'UseCase' => [ 'type' => 'structure', 'members' => [ 'UseCaseId' => [ 'shape' => 'UseCaseId', ], 'UseCaseArn' => [ 'shape' => 'ARN', ], 'UseCaseType' => [ 'shape' => 'UseCaseType', ], ], ], 'UseCaseId' => [ 'type' => 'string', 'max' => 200, 'min' => 1, ], 'UseCaseSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UseCase', ], ], 'UseCaseType' => [ 'type' => 'string', 'enum' => [ 'RULES_EVALUATION', 'CONNECT_CAMPAIGNS', ], ], 'User' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Username' => [ 'shape' => 'AgentUsername', ], 'IdentityInfo' => [ 'shape' => 'UserIdentityInfo', ], 'PhoneConfig' => [ 'shape' => 'UserPhoneConfig', ], 'DirectoryUserId' => [ 'shape' => 'DirectoryUserId', ], 'SecurityProfileIds' => [ 'shape' => 'SecurityProfileIds', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'Tags' => [ 'shape' => 'TagMap', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'UserData' => [ 'type' => 'structure', 'members' => [ 'User' => [ 'shape' => 'UserReference', ], 'RoutingProfile' => [ 'shape' => 'RoutingProfileReference', ], 'HierarchyPath' => [ 'shape' => 'HierarchyPathReference', ], 'Status' => [ 'shape' => 'AgentStatusReference', ], 'AvailableSlotsByChannel' => [ 'shape' => 'ChannelToCountMap', ], 'MaxSlotsByChannel' => [ 'shape' => 'ChannelToCountMap', ], 'ActiveSlotsByChannel' => [ 'shape' => 'ChannelToCountMap', ], 'Contacts' => [ 'shape' => 'AgentContactReferenceList', ], 'NextStatus' => [ 'shape' => 'AgentStatusName', ], ], ], 'UserDataFilters' => [ 'type' => 'structure', 'members' => [ 'Queues' => [ 'shape' => 'Queues', ], 'ContactFilter' => [ 'shape' => 'ContactFilter', ], 'RoutingProfiles' => [ 'shape' => 'RoutingProfiles', ], 'Agents' => [ 'shape' => 'AgentsMinOneMaxHundred', ], 'UserHierarchyGroups' => [ 'shape' => 'UserDataHierarchyGroups', ], ], ], 'UserDataHierarchyGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'HierarchyGroupId', ], 'max' => 1, 'min' => 1, ], 'UserDataList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserData', ], ], 'UserId' => [ 'type' => 'string', ], 'UserIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserId', ], ], 'UserIdentityInfo' => [ 'type' => 'structure', 'members' => [ 'FirstName' => [ 'shape' => 'AgentFirstName', ], 'LastName' => [ 'shape' => 'AgentLastName', ], 'Email' => [ 'shape' => 'Email', ], 'SecondaryEmail' => [ 'shape' => 'Email', ], 'Mobile' => [ 'shape' => 'PhoneNumber', ], ], ], 'UserIdentityInfoLite' => [ 'type' => 'structure', 'members' => [ 'FirstName' => [ 'shape' => 'AgentFirstName', ], 'LastName' => [ 'shape' => 'AgentLastName', ], ], ], 'UserNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'Message', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'UserPhoneConfig' => [ 'type' => 'structure', 'required' => [ 'PhoneType', ], 'members' => [ 'PhoneType' => [ 'shape' => 'PhoneType', ], 'AutoAccept' => [ 'shape' => 'AutoAccept', ], 'AfterContactWorkTimeLimit' => [ 'shape' => 'AfterContactWorkTimeLimit', ], 'DeskPhoneNumber' => [ 'shape' => 'PhoneNumber', ], ], ], 'UserProficiency' => [ 'type' => 'structure', 'required' => [ 'AttributeName', 'AttributeValue', 'Level', ], 'members' => [ 'AttributeName' => [ 'shape' => 'PredefinedAttributeName', ], 'AttributeValue' => [ 'shape' => 'PredefinedAttributeStringValue', ], 'Level' => [ 'shape' => 'ProficiencyLevel', ], ], ], 'UserProficiencyDisassociate' => [ 'type' => 'structure', 'required' => [ 'AttributeName', 'AttributeValue', ], 'members' => [ 'AttributeName' => [ 'shape' => 'PredefinedAttributeName', ], 'AttributeValue' => [ 'shape' => 'PredefinedAttributeStringValue', ], ], ], 'UserProficiencyDisassociateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProficiencyDisassociate', ], ], 'UserProficiencyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserProficiency', ], ], 'UserQuickConnectConfig' => [ 'type' => 'structure', 'required' => [ 'UserId', 'ContactFlowId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], 'ContactFlowId' => [ 'shape' => 'ContactFlowId', ], ], ], 'UserReference' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserId', ], 'Arn' => [ 'shape' => 'ARN', ], ], ], 'UserSearchConditionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserSearchCriteria', ], ], 'UserSearchCriteria' => [ 'type' => 'structure', 'members' => [ 'OrConditions' => [ 'shape' => 'UserSearchConditionList', ], 'AndConditions' => [ 'shape' => 'UserSearchConditionList', ], 'StringCondition' => [ 'shape' => 'StringCondition', ], 'HierarchyGroupCondition' => [ 'shape' => 'HierarchyGroupCondition', ], ], ], 'UserSearchFilter' => [ 'type' => 'structure', 'members' => [ 'TagFilter' => [ 'shape' => 'ControlPlaneTagFilter', ], 'UserAttributeFilter' => [ 'shape' => 'ControlPlaneUserAttributeFilter', ], ], ], 'UserSearchSummary' => [ 'type' => 'structure', 'members' => [ 'Arn' => [ 'shape' => 'ARN', ], 'DirectoryUserId' => [ 'shape' => 'DirectoryUserId', ], 'HierarchyGroupId' => [ 'shape' => 'HierarchyGroupId', ], 'Id' => [ 'shape' => 'UserId', ], 'IdentityInfo' => [ 'shape' => 'UserIdentityInfoLite', ], 'PhoneConfig' => [ 'shape' => 'UserPhoneConfig', ], 'RoutingProfileId' => [ 'shape' => 'RoutingProfileId', ], 'SecurityProfileIds' => [ 'shape' => 'SecurityProfileIds', ], 'Tags' => [ 'shape' => 'TagMap', ], 'Username' => [ 'shape' => 'AgentUsername', ], ], ], 'UserSearchSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserSearchSummary', ], ], 'UserSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'UserId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Username' => [ 'shape' => 'AgentUsername', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedRegion' => [ 'shape' => 'RegionName', ], ], ], 'UserSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserSummary', ], ], 'UserTagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'Value' => [ 'type' => 'double', ], 'VersionNumber' => [ 'type' => 'integer', 'min' => 1, ], 'VideoCapability' => [ 'type' => 'string', 'enum' => [ 'SEND', ], ], 'View' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ViewId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'ViewName', ], 'Status' => [ 'shape' => 'ViewStatus', ], 'Type' => [ 'shape' => 'ViewType', ], 'Description' => [ 'shape' => 'ViewDescription', ], 'Version' => [ 'shape' => 'ViewVersion', ], 'VersionDescription' => [ 'shape' => 'ViewDescription', ], 'Content' => [ 'shape' => 'ViewContent', ], 'Tags' => [ 'shape' => 'TagMap', ], 'CreatedTime' => [ 'shape' => 'Timestamp', ], 'LastModifiedTime' => [ 'shape' => 'Timestamp', ], 'ViewContentSha256' => [ 'shape' => 'ViewContentSha256', ], ], ], 'ViewAction' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{N}_.:\\/=+\\-@()\']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()\']*)$', 'sensitive' => true, ], 'ViewActions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ViewAction', ], ], 'ViewContent' => [ 'type' => 'structure', 'members' => [ 'InputSchema' => [ 'shape' => 'ViewInputSchema', ], 'Template' => [ 'shape' => 'ViewTemplate', ], 'Actions' => [ 'shape' => 'ViewActions', ], ], ], 'ViewContentSha256' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[a-zA-Z0-9]$', ], 'ViewDescription' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^([\\p{L}\\p{N}_.:\\/=+\\-@,()\']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@,()\']*)$', ], 'ViewId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-:\\/$]+$', ], 'ViewInputContent' => [ 'type' => 'structure', 'members' => [ 'Template' => [ 'shape' => 'ViewTemplate', ], 'Actions' => [ 'shape' => 'ViewActions', ], ], ], 'ViewInputSchema' => [ 'type' => 'string', 'sensitive' => true, ], 'ViewName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '^([\\p{L}\\p{N}_.:\\/=+\\-@()\']+[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@()\']*)$', 'sensitive' => true, ], 'ViewStatus' => [ 'type' => 'string', 'enum' => [ 'PUBLISHED', 'SAVED', ], ], 'ViewSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ViewId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Name' => [ 'shape' => 'ViewName', ], 'Type' => [ 'shape' => 'ViewType', ], 'Status' => [ 'shape' => 'ViewStatus', ], 'Description' => [ 'shape' => 'ViewDescription', ], ], ], 'ViewTemplate' => [ 'type' => 'string', ], 'ViewType' => [ 'type' => 'string', 'enum' => [ 'CUSTOMER_MANAGED', 'AWS_MANAGED', ], ], 'ViewVersion' => [ 'type' => 'integer', ], 'ViewVersionSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ViewId', ], 'Arn' => [ 'shape' => 'ARN', ], 'Description' => [ 'shape' => 'ViewDescription', ], 'Name' => [ 'shape' => 'ViewName', ], 'Type' => [ 'shape' => 'ViewType', ], 'Version' => [ 'shape' => 'ViewVersion', ], 'VersionDescription' => [ 'shape' => 'ViewDescription', ], ], ], 'ViewVersionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ViewVersionSummary', ], ], 'ViewsClientToken' => [ 'type' => 'string', 'max' => 500, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$', ], 'ViewsInstanceId' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[a-zA-Z0-9\\_\\-:\\/]+$', ], 'ViewsNextToken' => [ 'type' => 'string', 'max' => 4096, 'min' => 1, 'pattern' => '^[a-zA-Z0-9=\\/+_.-]+$', ], 'ViewsSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ViewSummary', ], ], 'Vocabulary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'Arn', 'LanguageCode', 'State', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'VocabularyName', ], 'Id' => [ 'shape' => 'VocabularyId', ], 'Arn' => [ 'shape' => 'ARN', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'State' => [ 'shape' => 'VocabularyState', ], 'LastModifiedTime' => [ 'shape' => 'VocabularyLastModifiedTime', ], 'FailureReason' => [ 'shape' => 'VocabularyFailureReason', ], 'Content' => [ 'shape' => 'VocabularyContent', ], 'Tags' => [ 'shape' => 'TagMap', ], ], ], 'VocabularyContent' => [ 'type' => 'string', 'max' => 60000, 'min' => 1, ], 'VocabularyFailureReason' => [ 'type' => 'string', ], 'VocabularyId' => [ 'type' => 'string', 'max' => 500, 'min' => 1, ], 'VocabularyLanguageCode' => [ 'type' => 'string', 'enum' => [ 'ar-AE', 'de-CH', 'de-DE', 'en-AB', 'en-AU', 'en-GB', 'en-IE', 'en-IN', 'en-US', 'en-WL', 'es-ES', 'es-US', 'fr-CA', 'fr-FR', 'hi-IN', 'it-IT', 'ja-JP', 'ko-KR', 'pt-BR', 'pt-PT', 'zh-CN', 'en-NZ', 'en-ZA', ], ], 'VocabularyLastModifiedTime' => [ 'type' => 'timestamp', ], 'VocabularyName' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '^[0-9a-zA-Z._-]+', ], 'VocabularyNextToken' => [ 'type' => 'string', 'max' => 131070, 'min' => 1, 'pattern' => '.*\\S.*', ], 'VocabularyState' => [ 'type' => 'string', 'enum' => [ 'CREATION_IN_PROGRESS', 'ACTIVE', 'CREATION_FAILED', 'DELETE_IN_PROGRESS', ], ], 'VocabularySummary' => [ 'type' => 'structure', 'required' => [ 'Name', 'Id', 'Arn', 'LanguageCode', 'State', 'LastModifiedTime', ], 'members' => [ 'Name' => [ 'shape' => 'VocabularyName', ], 'Id' => [ 'shape' => 'VocabularyId', ], 'Arn' => [ 'shape' => 'ARN', ], 'LanguageCode' => [ 'shape' => 'VocabularyLanguageCode', ], 'State' => [ 'shape' => 'VocabularyState', ], 'LastModifiedTime' => [ 'shape' => 'VocabularyLastModifiedTime', ], 'FailureReason' => [ 'shape' => 'VocabularyFailureReason', ], ], ], 'VocabularySummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VocabularySummary', ], ], 'VoiceRecordingConfiguration' => [ 'type' => 'structure', 'members' => [ 'VoiceRecordingTrack' => [ 'shape' => 'VoiceRecordingTrack', ], ], ], 'VoiceRecordingTrack' => [ 'type' => 'string', 'enum' => [ 'FROM_AGENT', 'TO_AGENT', 'ALL', ], ], 'WisdomInfo' => [ 'type' => 'structure', 'members' => [ 'SessionArn' => [ 'shape' => 'ARN', ], ], ], 'resourceArnListMaxLimit100' => [ 'type' => 'list', 'member' => [ 'shape' => 'ARN', ], 'max' => 100, 'min' => 1, ], 'timestamp' => [ 'type' => 'timestamp', ], ],]; diff --git a/src/data/connect/2017-08-08/docs-2.json b/src/data/connect/2017-08-08/docs-2.json index 55c2e99473..f259fca2b5 100644 --- a/src/data/connect/2017-08-08/docs-2.json +++ b/src/data/connect/2017-08-08/docs-2.json @@ -121,7 +121,7 @@ "GetPromptFile": "Gets the prompt file.
", "GetTaskTemplate": "Gets details about a specific task template in the specified Amazon Connect instance.
", "GetTrafficDistribution": "Retrieves the current traffic distribution for a given traffic distribution group.
", - "ImportPhoneNumber": "Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
", + "ImportPhoneNumber": "Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber
operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
", "ListAgentStatuses": "This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
", "ListAnalyticsDataAssociations": "This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
", "ListApprovedOrigins": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
", @@ -189,10 +189,10 @@ "SearchVocabularies": "Searches for vocabularies within a specific Amazon Connect instance using State
, NameStartsWith
, and LanguageCode
.
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
", "StartAttachedFileUpload": "Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests
exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see Chat in the Amazon Connect Administrator Guide.
", + "StartChatContact": "Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests
exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
", "StartContactEvaluation": "Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
", - "StartContactStreaming": "Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
", + "StartContactStreaming": "Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
", "StartOutboundVoiceContact": "Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType
= CAMPAIGN
, you must submit a service quota increase request to the quota Amazon Connect campaigns.
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId
and RelatedContactId
input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId
will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId
.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same RelatedContactId
.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID
, QuickConnectID
, or TaskTemplateID
. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID
is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException
occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId
. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
", @@ -501,6 +501,18 @@ "SearchCriteria$AgentHierarchyGroups": "The agent hierarchy groups of the agent at the time of handling the contact.
" } }, + "AgentId": { + "base": null, + "refs": { + "AgentIds$member": null + } + }, + "AgentIds": { + "base": null, + "refs": { + "AgentsCriteria$AgentIds": "An object to specify a list of agents, by Agent ID.
" + } + }, "AgentInfo": { "base": "Information about the agent who accepted the contact.
", "refs": { @@ -635,6 +647,12 @@ "UserSummary$Username": "The Amazon Connect user name of the user account.
" } }, + "AgentsCriteria": { + "base": "Can be used to define a list of preferred agents to target the contact within the queue. Note that agents must have the queue in their routing profile in order to be offered the contact.
", + "refs": { + "MatchCriteria$AgentsCriteria": "An object to define AgentIds
.
a Double number value type.
" + "FieldValueUnion$DoubleValue": "A Double number value type.
" } }, "DownloadUrlMetadata": { @@ -4938,6 +4956,12 @@ "RoutingProfile$NumberOfAssociatedUsers": "The number of associated users in routing profile.
" } }, + "MatchCriteria": { + "base": "An object to define AgentsCriteria
.
An object to define AgentsCriteria
.
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. For now, this metric only supports the following as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Metric filter:
Valid values: API
| Incoming
| Outbound
| Transfer
| Callback
| Queue_Transfer
| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts answered in X seconds
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE
is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. For now, this metric only supports the following as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: This metric is not available in Amazon Connect admin website.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE
is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API
| Incoming
| Outbound
| Transfer
| Callback
| Queue_Transfer
| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
Notification recipient.
" } }, + "NullableProficiencyLevel": { + "base": null, + "refs": { + "AttributeCondition$ProficiencyLevel": "The proficiency level of the condition.
" + } + }, "NumberReference": { "base": "Information about a reference when the referenceType
is NUMBER
. Otherwise, null.
The proficiency level of the condition.
", "UserProficiency$Level": "The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
" } }, @@ -7210,7 +7239,7 @@ "SearchableContactAttributes": { "base": "A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
", "refs": { - "SearchCriteria$SearchableContactAttributes": "The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by customer contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes
in a search request, the GetContactAttributes
action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes
in a search request, the GetContactAttributes
action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
A structure that defineds the field name to sort by and a sort order.
", + "base": "A structure that defines the field name to sort by and a sort order.
", "refs": { "SearchContactsRequest$Sort": "Specifies a field to sort by and a sort order.
" } diff --git a/src/data/connect/2017-08-08/docs-2.json.php b/src/data/connect/2017-08-08/docs-2.json.php index 07029492a8..c5ccb2c2ac 100644 --- a/src/data/connect/2017-08-08/docs-2.json.php +++ b/src/data/connect/2017-08-08/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
', 'operations' => [ 'ActivateEvaluationForm' => 'Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
', 'AssociateAnalyticsDataSet' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
', 'AssociateApprovedOrigin' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
', 'AssociateBot' => 'This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
', 'AssociateDefaultVocabulary' => 'Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
', 'AssociateFlow' => 'Associates a connect resource to a flow.
', 'AssociateInstanceStorageConfig' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can\'t define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn\'t exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
', 'AssociateLambdaFunction' => 'This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
', 'AssociateLexBot' => 'This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
', 'AssociatePhoneNumberContactFlow' => 'Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
', 'AssociateRoutingProfileQueues' => 'Associates a set of queues with a routing profile.
', 'AssociateSecurityKey' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
', 'AssociateTrafficDistributionGroupUser' => 'Associates an agent with a traffic distribution group.
', 'AssociateUserProficiencies' => '>Associates a set of proficiencies with a user.
', 'BatchAssociateAnalyticsDataSet' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
', 'BatchDisassociateAnalyticsDataSet' => 'This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
', 'BatchGetAttachedFileMetadata' => 'Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
', 'BatchGetFlowAssociation' => 'Retrieve the flow associations for the given resources.
', 'BatchPutContact' => 'Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
', 'ClaimPhoneNumber' => 'Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
', 'CompleteAttachedFileUpload' => 'Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
', 'CreateAgentStatus' => 'This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
', 'CreateContactFlow' => 'Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
', 'CreateContactFlowModule' => 'Creates a flow module for the specified Amazon Connect instance.
', 'CreateEvaluationForm' => 'Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
', 'CreateHoursOfOperation' => 'This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
', 'CreateInstance' => 'This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
', 'CreateIntegrationAssociation' => 'Creates an Amazon Web Services resource association with an Amazon Connect instance.
', 'CreateParticipant' => 'Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
', 'CreatePersistentContactAssociation' => 'Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
', 'CreatePredefinedAttribute' => 'Creates a new predefined attribute for the specified Amazon Connect instance.
', 'CreatePrompt' => 'Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
', 'CreateQueue' => 'This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
Only use the phone number ARN format that doesn\'t contain instance
in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
Creates a quick connect for the specified Amazon Connect instance.
', 'CreateRoutingProfile' => 'Creates a new routing profile.
', 'CreateRule' => 'Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
', 'CreateSecurityProfile' => 'Creates a security profile.
', 'CreateTaskTemplate' => 'Creates a new task template in the specified Amazon Connect instance.
', 'CreateTrafficDistributionGroup' => 'Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
', 'CreateUseCase' => 'Creates a use case for an integration association.
', 'CreateUser' => 'Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some situations. For example, Email
is required if you are using SAML for identity management. FirstName
and LastName
are required if you are using Amazon Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
', 'CreateUserHierarchyGroup' => 'Creates a new user hierarchy group.
', 'CreateView' => 'Creates a new view with the possible status of SAVED
or PUBLISHED
.
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED
or full content validation if the status is set to PUBLISHED
. An error is returned if validation fails. It associates either the $SAVED
qualifier or both of the $SAVED
and $LATEST
qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.
Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST
alias.
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
', 'DeactivateEvaluationForm' => 'Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
', 'DeleteAttachedFile' => 'Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
Deletes a contact evaluation in the specified Amazon Connect instance.
', 'DeleteContactFlow' => 'Deletes a flow for the specified Amazon Connect instance.
', 'DeleteContactFlowModule' => 'Deletes the specified flow module.
', 'DeleteEvaluationForm' => 'Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
', 'DeleteInstance' => 'This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
', 'DeleteIntegrationAssociation' => 'Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
', 'DeletePredefinedAttribute' => 'Deletes a predefined attribute from the specified Amazon Connect instance.
', 'DeletePrompt' => 'Deletes a prompt.
', 'DeleteQueue' => 'Deletes a queue.
', 'DeleteQuickConnect' => 'Deletes a quick connect.
After calling DeleteUser, it\'s important to call DeleteQuickConnect
to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don\'t appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you\'re using Amazon Connect Global Resiliency.
Deletes a routing profile.
', 'DeleteRule' => 'Deletes a rule for the specified Amazon Connect instance.
', 'DeleteSecurityProfile' => 'Deletes a security profile.
', 'DeleteTaskTemplate' => 'Deletes the task template.
', 'DeleteTrafficDistributionGroup' => 'Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
', 'DeleteUseCase' => 'Deletes a use case from an integration association.
', 'DeleteUser' => 'Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user\'s data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don\'t appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you\'re using Amazon Connect Global Resiliency.
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
', 'DeleteView' => 'Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
', 'DeleteViewVersion' => 'Deletes the particular version specified in ViewVersion
identifier.
Deletes the vocabulary that has the given identifier.
', 'DescribeAgentStatus' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
', 'DescribeContact' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
Describes a contact evaluation in the specified Amazon Connect instance.
', 'DescribeContactFlow' => 'Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content. SAVED
does not initiate validation of the content. SAVED
| PUBLISHED
Describes the specified flow module.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
', 'DescribeHoursOfOperation' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
', 'DescribeInstance' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
', 'DescribeInstanceAttribute' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
', 'DescribeInstanceStorageConfig' => 'This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
', 'DescribePhoneNumber' => 'Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
Describes a predefined attribute for the specified Amazon Connect instance.
', 'DescribePrompt' => 'Describes the prompt.
', 'DescribeQueue' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
', 'DescribeQuickConnect' => 'Describes the quick connect.
', 'DescribeRoutingProfile' => 'Describes the specified routing profile.
', 'DescribeRule' => 'Describes a rule for the specified Amazon Connect instance.
', 'DescribeSecurityProfile' => 'Gets basic information about the security profle.
', 'DescribeTrafficDistributionGroup' => 'Gets details and status of a traffic distribution group.
', 'DescribeUser' => 'Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
', 'DescribeUserHierarchyGroup' => 'Describes the specified hierarchy group.
', 'DescribeUserHierarchyStructure' => 'Describes the hierarchy structure of the specified Amazon Connect instance.
', 'DescribeView' => 'Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED
needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED
, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST
. If it is not supplied, then $LATEST
is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.
Describes the specified vocabulary.
', 'DisassociateAnalyticsDataSet' => 'This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
', 'DisassociateApprovedOrigin' => 'This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
', 'DisassociateBot' => 'This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
', 'DisassociateFlow' => 'Disassociates a connect resource from a flow.
', 'DisassociateInstanceStorageConfig' => 'This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
', 'DisassociateLambdaFunction' => 'This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
', 'DisassociateLexBot' => 'This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
', 'DisassociatePhoneNumberContactFlow' => 'Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
', 'DisassociateRoutingProfileQueues' => 'Disassociates a set of queues from a routing profile.
', 'DisassociateSecurityKey' => 'This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
', 'DisassociateTrafficDistributionGroupUser' => 'Disassociates an agent from a traffic distribution group.
', 'DisassociateUserProficiencies' => 'Disassociates a set of proficiencies from a user.
', 'DismissUserContact' => 'Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED
, ERROR
, ENDED
, or REJECTED
state in the Agent Event Stream.
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED
.
Retrieves the contact attributes for the specified contact.
', 'GetCurrentMetricData' => 'Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
', 'GetCurrentUserData' => 'Gets the real-time active user data from the specified Amazon Connect instance.
', 'GetFederationToken' => 'Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn\'t support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
Retrieves the flow associated for a given resource.
', 'GetMetricData' => 'Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData
. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2
offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2
and GetMetricData
, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Gets the prompt file.
', 'GetTaskTemplate' => 'Gets details about a specific task template in the specified Amazon Connect instance.
', 'GetTrafficDistribution' => 'Retrieves the current traffic distribution for a given traffic distribution group.
', 'ImportPhoneNumber' => 'Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
', 'ListAgentStatuses' => 'This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
', 'ListAnalyticsDataAssociations' => 'This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
', 'ListApprovedOrigins' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
', 'ListBots' => 'This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
', 'ListContactEvaluations' => 'Lists contact evaluations in the specified Amazon Connect instance.
', 'ListContactFlowModules' => 'Provides information about the flow modules for the specified Amazon Connect instance.
', 'ListContactFlows' => 'Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
', 'ListContactReferences' => 'This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes
, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.
Lists the default vocabularies for the specified Amazon Connect instance.
', 'ListEvaluationFormVersions' => 'Lists versions of an evaluation form in the specified Amazon Connect instance.
', 'ListEvaluationForms' => 'Lists evaluation forms in the specified Amazon Connect instance.
', 'ListFlowAssociations' => 'List the flow association based on the filters.
', 'ListHoursOfOperations' => 'Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
', 'ListInstanceAttributes' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
', 'ListInstanceStorageConfigs' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
', 'ListInstances' => 'This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren\'t successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
', 'ListIntegrationAssociations' => 'Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
', 'ListLambdaFunctions' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
', 'ListLexBots' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
', 'ListPhoneNumbers' => 'Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn\'t support number types UIFN
, SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE
or DID
.
The phone number Arn
value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException
. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2
returns only the phone numbers claimed to the instance.
When given a traffic distribution group ARN ListPhoneNumbersV2
returns only the phone numbers claimed to the traffic distribution group.
Lists predefined attributes for the specified Amazon Connect instance.
', 'ListPrompts' => 'Provides information about the prompts for the specified Amazon Connect instance.
', 'ListQueueQuickConnects' => 'This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
', 'ListQueues' => 'Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes
parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
', 'ListQuickConnects' => 'Provides information about the quick connects for the specified Amazon Connect instance.
', 'ListRealtimeContactAnalysisSegmentsV2' => 'Provides a list of analysis segments for a real-time analysis session.
', 'ListRoutingProfileQueues' => 'Lists the queues associated with a routing profile.
', 'ListRoutingProfiles' => 'Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
', 'ListRules' => 'List all rules for the specified Amazon Connect instance.
', 'ListSecurityKeys' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
', 'ListSecurityProfileApplications' => 'Returns a list of third-party applications in a specific security profile.
', 'ListSecurityProfilePermissions' => 'Lists the permissions granted to a security profile.
', 'ListSecurityProfiles' => 'Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
', 'ListTagsForResource' => 'Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
', 'ListTaskTemplates' => 'Lists task templates for the specified Amazon Connect instance.
', 'ListTrafficDistributionGroupUsers' => 'Lists traffic distribution group users.
', 'ListTrafficDistributionGroups' => 'Lists traffic distribution groups.
', 'ListUseCases' => 'Lists the use cases for the integration association.
', 'ListUserHierarchyGroups' => 'Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
', 'ListUserProficiencies' => 'Lists proficiencies associated with a user.
', 'ListUsers' => 'Provides summary information about the users for the specified Amazon Connect instance.
', 'ListViewVersions' => 'Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
', 'ListViews' => 'Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
', 'MonitorContact' => 'Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
', 'PauseContact' => 'Allows pausing an ongoing task contact.
', 'PutUserStatus' => 'Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent\'s next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
', 'ReleasePhoneNumber' => 'Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber
API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
', 'ReplicateInstance' => 'Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
', 'ResumeContact' => 'Allows resuming a task contact in a paused state.
', 'ResumeContactRecording' => 'When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
', 'SearchAvailablePhoneNumbers' => 'Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
', 'SearchContactFlows' => 'Searches the contact flows in an Amazon Connect instance, with optional filtering.
', 'SearchContacts' => 'Searches contacts in an Amazon Connect instance.
', 'SearchHoursOfOperations' => 'Searches the hours of operation in an Amazon Connect instance, with optional filtering.
', 'SearchPredefinedAttributes' => 'Predefined attributes that meet certain criteria.
', 'SearchPrompts' => 'Searches prompts in an Amazon Connect instance, with optional filtering.
', 'SearchQueues' => 'Searches queues in an Amazon Connect instance, with optional filtering.
', 'SearchQuickConnects' => 'Searches quick connects in an Amazon Connect instance, with optional filtering.
', 'SearchResourceTags' => 'Searches tags used in an Amazon Connect instance using optional search criteria.
', 'SearchRoutingProfiles' => 'Searches routing profiles in an Amazon Connect instance, with optional filtering.
', 'SearchSecurityProfiles' => 'Searches security profiles in an Amazon Connect instance, with optional filtering.
', 'SearchUsers' => 'Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
Searches for vocabularies within a specific Amazon Connect instance using State
, NameStartsWith
, and LanguageCode
.
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
', 'StartAttachedFileUpload' => 'Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests
exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see Chat in the Amazon Connect Administrator Guide.
', 'StartContactEvaluation' => 'Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can\'t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
', 'StartContactStreaming' => 'Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
', 'StartOutboundVoiceContact' => 'Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that\'s specified (in ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType
= CAMPAIGN
, you must submit a service quota increase request to the quota Amazon Connect campaigns.
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId
and RelatedContactId
input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId
will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId
.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same RelatedContactId
.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID
, QuickConnectID
, or TaskTemplateID
. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID
is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException
occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId
. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
', 'StopContact' => 'Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
', 'StopContactRecording' => 'Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can\'t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
', 'StopContactStreaming' => 'Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
', 'SubmitContactEvaluation' => 'Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}
) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
', 'SuspendContactRecording' => 'When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
', 'TagContact' => 'Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
', 'TagResource' => 'Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
', 'TransferContact' => 'Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only TASK
contacts.
Do not use both QueueId
and UserId
in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact
API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
', 'UntagResource' => 'Removes the specified tags from the specified resource.
', 'UpdateAgentStatus' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
', 'UpdateContact' => 'This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer\'s name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
', 'UpdateContactEvaluation' => 'Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}
) to the question identifier.
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Updates metadata about specified flow.
', 'UpdateContactFlowModuleContent' => 'Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Updates metadata about specified flow module.
', 'UpdateContactFlowName' => 'The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
', 'UpdateContactRoutingData' => 'Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer\'s position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
Updates the scheduled time of a task contact that is already scheduled.
', 'UpdateEvaluationForm' => 'Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
', 'UpdateHoursOfOperation' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
', 'UpdateInstanceAttribute' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
', 'UpdateInstanceStorageConfig' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
', 'UpdateParticipantRoleConfig' => 'Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
', 'UpdatePhoneNumber' => 'Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn\'t migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
Updates a predefined attribute for the specified Amazon Connect instance.
', 'UpdatePrompt' => 'Updates a prompt.
', 'UpdateQueueHoursOfOperation' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
', 'UpdateQueueMaxContacts' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
', 'UpdateQueueName' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name
or Description
must be provided.
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
Only use the phone number ARN format that doesn\'t contain instance
in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
', 'UpdateQuickConnectConfig' => 'Updates the configuration settings for the specified quick connect.
', 'UpdateQuickConnectName' => 'Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name
or Description
must be provided.
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
', 'UpdateRoutingProfileConcurrency' => 'Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
', 'UpdateRoutingProfileDefaultOutboundQueue' => 'Updates the default outbound queue of a routing profile.
', 'UpdateRoutingProfileName' => 'Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name
or Description
must be provided.
Updates the properties associated with a set of queues for a routing profile.
', 'UpdateRule' => 'Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
', 'UpdateSecurityProfile' => 'Updates a security profile.
', 'UpdateTaskTemplate' => 'Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
', 'UpdateTrafficDistribution' => 'Updates the traffic distribution for a given traffic distribution group.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.
', 'UpdateUserHierarchy' => 'Assigns the specified hierarchy group to the specified user.
', 'UpdateUserHierarchyGroupName' => 'Updates the name of the user hierarchy group.
', 'UpdateUserHierarchyStructure' => 'Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
', 'UpdateUserIdentityInfo' => 'Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo
. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker\'s email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
Updates the phone configuration settings for the specified user.
', 'UpdateUserProficiencies' => 'Updates the properties associated with the proficiencies of a user.
', 'UpdateUserRoutingProfile' => 'Assigns the specified routing profile to the specified user.
', 'UpdateUserSecurityProfiles' => 'Assigns the specified security profiles to the specified user.
', 'UpdateViewContent' => 'Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status
is set to SAVED
and performs full content validation if Status
is PUBLISHED
. Note that the $SAVED
alias\' content will always be updated, but the $LATEST
alias\' content will only be updated if Status
is PUBLISHED
.
Updates the view metadata. Note that either Name
or Description
must be provided.
The Amazon Resource Name (ARN) for the evaluation form resource.
', 'AgentHierarchyGroup$Arn' => 'The Amazon Resource Name (ARN) of the group.
', 'AgentStatus$AgentStatusARN' => 'The Amazon Resource Name (ARN) of the agent status.
', 'AgentStatusReference$StatusArn' => 'The Amazon Resource Name (ARN) of the agent\'s status.
', 'AgentStatusSummary$Arn' => 'The Amazon Resource Name (ARN) for the agent status.
', 'AnalyticsDataAssociationResult$ResourceShareArn' => 'The Amazon Resource Name (ARN) of the Resource Access Manager share.
', 'AssociateAnalyticsDataSetResponse$ResourceShareArn' => 'The Amazon Resource Name (ARN) of the Resource Access Manager share.
', 'AssociateFlowRequest$ResourceId' => 'The identifier of the resource.
', 'AssociateFlowRequest$FlowId' => 'The identifier of the flow.
', 'AttachedFile$FileArn' => 'The unique identifier of the attached file resource (ARN).
', 'AttachedFile$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
The Amazon Resource Name (ARN) of the phone number.
', 'ClaimedPhoneNumberSummary$PhoneNumberArn' => 'The Amazon Resource Name (ARN) of the phone number.
', 'ClaimedPhoneNumberSummary$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
', 'ClaimedPhoneNumberSummary$SourcePhoneNumberArn' => 'The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
', 'CompleteAttachedFileUploadRequest$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The Amazon Resource Name (ARN) for the contact.
', 'ContactFlow$Arn' => 'The Amazon Resource Name (ARN) of the flow.
', 'ContactFlowModule$Arn' => 'The Amazon Resource Name (ARN).
', 'ContactFlowModuleSummary$Arn' => 'The Amazon Resource Name (ARN) of the flow module.
', 'ContactFlowSummary$Arn' => 'The Amazon Resource Name (ARN) of the flow.
', 'ContactSearchSummary$Arn' => 'The Amazon Resource Name (ARN) of the contact.
', 'CreateAgentStatusResponse$AgentStatusARN' => 'The Amazon Resource Name (ARN) of the agent status.
', 'CreateContactFlowModuleResponse$Arn' => 'The Amazon Resource Name (ARN) of the flow module.
', 'CreateContactFlowResponse$ContactFlowArn' => 'The Amazon Resource Name (ARN) of the flow.
', 'CreateEvaluationFormResponse$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'CreateHoursOfOperationResponse$HoursOfOperationArn' => 'The Amazon Resource Name (ARN) for the hours of operation.
', 'CreateInstanceResponse$Arn' => 'The Amazon Resource Name (ARN) of the instance.
', 'CreateIntegrationAssociationRequest$IntegrationArn' => 'The Amazon Resource Name (ARN) of the integration.
When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
The Amazon Resource Name (ARN) for the association.
', 'CreatePromptResponse$PromptARN' => 'The Amazon Resource Name (ARN) of the prompt.
', 'CreateQueueResponse$QueueArn' => 'The Amazon Resource Name (ARN) of the queue.
', 'CreateQuickConnectResponse$QuickConnectARN' => 'The Amazon Resource Name (ARN) for the quick connect.
', 'CreateRoutingProfileResponse$RoutingProfileArn' => 'The Amazon Resource Name (ARN) of the routing profile.
', 'CreateRuleResponse$RuleArn' => 'The Amazon Resource Name (ARN) of the rule.
', 'CreateSecurityProfileResponse$SecurityProfileArn' => 'The Amazon Resource Name (ARN) for the security profile.
', 'CreateUseCaseResponse$UseCaseArn' => 'The Amazon Resource Name (ARN) for the use case.
', 'CreateUserHierarchyGroupResponse$HierarchyGroupArn' => 'The Amazon Resource Name (ARN) of the hierarchy group.
', 'CreateUserResponse$UserArn' => 'The Amazon Resource Name (ARN) of the user account.
', 'CreateVocabularyResponse$VocabularyArn' => 'The Amazon Resource Name (ARN) of the custom vocabulary.
', 'CreatedByInfo$ConnectUserArn' => 'An agent ARN representing a connect user.
', 'CreatedByInfo$AWSIdentityArn' => 'STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn
is not provided.
The Amazon Resource Name (ARN) for the evaluation form resource.
', 'DeleteAttachedFileRequest$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The Amazon Resource Name (ARN) of the custom vocabulary.
', 'DisassociateFlowRequest$ResourceId' => 'The identifier of the resource.
', 'Evaluation$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'EvaluationForm$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'EvaluationForm$CreatedBy' => 'The Amazon Resource Name (ARN) of the user who created the evaluation form.
', 'EvaluationForm$LastModifiedBy' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
', 'EvaluationFormContent$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'EvaluationFormSummary$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'EvaluationFormSummary$CreatedBy' => 'The Amazon Resource Name (ARN) of the user who created the evaluation form.
', 'EvaluationFormSummary$LastModifiedBy' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
', 'EvaluationFormSummary$LastActivatedBy' => 'The Amazon Resource Name (ARN) of the user who last activated the evaluation form.
', 'EvaluationFormVersionSummary$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'EvaluationFormVersionSummary$CreatedBy' => 'The Amazon Resource Name (ARN) of the user who created the evaluation form.
', 'EvaluationFormVersionSummary$LastModifiedBy' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
', 'EvaluationMetadata$EvaluatorArn' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation.
', 'EvaluationSummary$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'EvaluationSummary$EvaluatorArn' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation.
', 'FlowAssociationSummary$ResourceId' => 'The identifier of the resource.
', 'FlowAssociationSummary$FlowId' => 'The identifier of the flow.
', 'GetAttachedFileRequest$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource (ARN).
', 'GetAttachedFileResponse$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
', 'GetFederationTokenResponse$UserArn' => 'The Amazon Resource Name (ARN) of the user.
', 'GetFlowAssociationRequest$ResourceId' => 'The identifier of the resource.
', 'GetFlowAssociationResponse$ResourceId' => 'The identifier of the resource.
', 'GetFlowAssociationResponse$FlowId' => 'The identifier of the flow.
', 'GetMetricDataV2Request$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource. This includes the instanceId
an Amazon Connect instance.
The Amazon Resource Name (ARN) of the hierarchy group.
', 'HierarchyGroupSummary$Arn' => 'The Amazon Resource Name (ARN) of the hierarchy group.
', 'HierarchyGroupSummaryReference$Arn' => 'The Amazon Resource Name (ARN) for the hierarchy group.
', 'HierarchyLevel$Arn' => 'The Amazon Resource Name (ARN) of the hierarchy level.
', 'HoursOfOperation$HoursOfOperationArn' => 'The Amazon Resource Name (ARN) for the hours of operation.
', 'HoursOfOperationSummary$Arn' => 'The Amazon Resource Name (ARN) of the hours of operation.
', 'ImportPhoneNumberRequest$SourcePhoneNumberArn' => 'The claimed phone number ARN being imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number to import from Amazon Pinpoint.
', 'ImportPhoneNumberResponse$PhoneNumberArn' => 'The Amazon Resource Name (ARN) of the phone number.
', 'Instance$Arn' => 'The Amazon Resource Name (ARN) of the instance.
', 'Instance$ServiceRole' => 'The service role of the instance.
', 'InstanceSummary$Arn' => 'The Amazon Resource Name (ARN) of the instance.
', 'InstanceSummary$ServiceRole' => 'The service role of the instance.
', 'IntegrationAssociationSummary$IntegrationAssociationArn' => 'The Amazon Resource Name (ARN) for the AppIntegration association.
', 'IntegrationAssociationSummary$IntegrationArn' => 'The Amazon Resource Name (ARN) for the AppIntegration.
', 'KinesisFirehoseConfig$FirehoseArn' => 'The Amazon Resource Name (ARN) of the delivery stream.
', 'KinesisStreamConfig$StreamArn' => 'The Amazon Resource Name (ARN) of the data stream.
', 'ListIntegrationAssociationsRequest$IntegrationArn' => 'The Amazon Resource Name (ARN) of the integration.
', 'ListPhoneNumbersSummary$PhoneNumberArn' => 'The Amazon Resource Name (ARN) of the phone number.
', 'ListPhoneNumbersSummary$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
', 'ListPhoneNumbersSummary$SourcePhoneNumberArn' => 'The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
', 'ListPhoneNumbersV2Request$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both TargetArn
and InstanceId
input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.
', 'MonitorContactResponse$ContactArn' => 'The ARN of the contact.
', 'PhoneNumberSummary$Arn' => 'The Amazon Resource Name (ARN) of the phone number.
', 'Prompt$PromptARN' => 'The Amazon Resource Name (ARN) of the prompt.
', 'PromptSummary$Arn' => 'The Amazon Resource Name (ARN) of the prompt.
', 'Queue$QueueArn' => 'The Amazon Resource Name (ARN) for the queue.
', 'QueueReference$Arn' => 'The Amazon Resource Name (ARN) of the queue.
', 'QueueSummary$Arn' => 'The Amazon Resource Name (ARN) of the queue.
', 'QuickConnect$QuickConnectARN' => 'The Amazon Resource Name (ARN) of the quick connect.
', 'QuickConnectSummary$Arn' => 'The Amazon Resource Name (ARN) of the quick connect.
', 'ReplicateInstanceResponse$Arn' => 'The Amazon Resource Name (ARN) of the replicated instance.
', 'ResourceInUseException$ResourceId' => 'The identifier for the resource.
', 'RoutingProfile$RoutingProfileArn' => 'The Amazon Resource Name (ARN) of the routing profile.
', 'RoutingProfileQueueConfigSummary$QueueArn' => 'The Amazon Resource Name (ARN) of the queue.
', 'RoutingProfileReference$Arn' => 'The Amazon Resource Name (ARN) of the routing profile.
', 'RoutingProfileSummary$Arn' => 'The Amazon Resource Name (ARN) of the routing profile.
', 'Rule$RuleArn' => 'The Amazon Resource Name (ARN) of the rule.
', 'Rule$LastUpdatedBy' => 'The Amazon Resource Name (ARN) of the user who last updated the rule.
', 'RuleSummary$RuleArn' => 'The Amazon Resource Name (ARN) of the rule.
', 'SearchAvailablePhoneNumbersRequest$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
The Amazon Resource Name (ARN) for the secruity profile.
', 'SecurityProfileSearchSummary$Arn' => 'The Amazon Resource Name (ARN) of the security profile.
', 'SecurityProfileSummary$Arn' => 'The Amazon Resource Name (ARN) of the security profile.
', 'StartAttachedFileUploadRequest$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource (ARN).
', 'StartContactEvaluationResponse$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'SubmitContactEvaluationResponse$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'TransferContactResponse$ContactArn' => 'The Amazon Resource Name (ARN) of the contact.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'UpdateContactEvaluationResponse$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'UpdateEvaluationFormResponse$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'UpdatePhoneNumberRequest$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
The Amazon Resource Name (ARN) of the phone number.
', 'UpdatePromptResponse$PromptARN' => 'The Amazon Resource Name (ARN) of the prompt.
', 'UseCase$UseCaseArn' => 'The Amazon Resource Name (ARN) for the use case.
', 'User$Arn' => 'The Amazon Resource Name (ARN) of the user account.
', 'UserReference$Arn' => 'The Amazon Resource Name (ARN) for the user.
', 'UserSearchSummary$Arn' => 'The Amazon Resource Name (ARN) of the user.
', 'UserSummary$Arn' => 'The Amazon Resource Name (ARN) of the user account.
', 'View$Arn' => 'The Amazon Resource Name (ARN) of the view.
', 'ViewSummary$Arn' => 'The Amazon Resource Name (ARN) of the view.
', 'ViewVersionSummary$Arn' => 'The Amazon Resource Name (ARN) of the view version.
', 'Vocabulary$Arn' => 'The Amazon Resource Name (ARN) of the custom vocabulary.
', 'VocabularySummary$Arn' => 'The Amazon Resource Name (ARN) of the custom vocabulary.
', 'WisdomInfo$SessionArn' => 'The Amazon Resource Name (ARN) of the Wisdom session.
', 'resourceArnListMaxLimit100$member' => NULL, ], ], 'AWSAccountId' => [ 'base' => NULL, 'refs' => [ 'AnalyticsDataAssociationResult$TargetAccountId' => 'The identifier of the target account.
', 'AssociateAnalyticsDataSetRequest$TargetAccountId' => 'The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
', 'AssociateAnalyticsDataSetResponse$TargetAccountId' => 'The identifier of the target account.
', 'BatchAssociateAnalyticsDataSetRequest$TargetAccountId' => 'The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
', 'BatchDisassociateAnalyticsDataSetRequest$TargetAccountId' => 'The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
', 'DisassociateAnalyticsDataSetRequest$TargetAccountId' => 'The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
', ], ], 'AccessDeniedException' => [ 'base' => 'You do not have sufficient permissions to perform this action.
', 'refs' => [], ], 'ActionSummaries' => [ 'base' => NULL, 'refs' => [ 'RuleSummary$ActionSummaries' => 'A list of ActionTypes associated with a rule.
', ], ], 'ActionSummary' => [ 'base' => 'Information about an action.
', 'refs' => [ 'ActionSummaries$member' => NULL, ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionType' => 'The action type.
', 'RuleAction$ActionType' => 'The type of action that creates a rule.
', ], ], 'ActivateEvaluationFormRequest' => [ 'base' => NULL, 'refs' => [], ], 'ActivateEvaluationFormResponse' => [ 'base' => NULL, 'refs' => [], ], 'AfterContactWorkTimeLimit' => [ 'base' => NULL, 'refs' => [ 'UserPhoneConfig$AfterContactWorkTimeLimit' => 'The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don\'t want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.
When returned by a SearchUsers
call, AfterContactWorkTimeLimit
is returned in milliseconds.
Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
', 'RoutingProfile$AgentAvailabilityTimer' => 'Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
', 'UpdateRoutingProfileAgentAvailabilityTimerRequest$AgentAvailabilityTimer' => 'Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
', ], ], 'AgentConfig' => [ 'base' => 'The distribution of agents between the instance and its replica(s).
', 'refs' => [ 'GetTrafficDistributionResponse$AgentConfig' => 'The distribution of agents between the instance and its replica(s).
', 'UpdateTrafficDistributionRequest$AgentConfig' => 'The distribution of agents between the instance and its replica(s).
', ], ], 'AgentContactReference' => [ 'base' => 'Information about the contact associated to the user.
', 'refs' => [ 'AgentContactReferenceList$member' => NULL, ], ], 'AgentContactReferenceList' => [ 'base' => NULL, 'refs' => [ 'UserData$Contacts' => 'A list of contact reference information.
', ], ], 'AgentFirstName' => [ 'base' => NULL, 'refs' => [ 'UserIdentityInfo$FirstName' => 'The first name. This is required if you are using Amazon Connect or SAML for identity management.
', 'UserIdentityInfoLite$FirstName' => 'The user\'s first name.
', ], ], 'AgentHierarchyGroup' => [ 'base' => 'Information about an agent hierarchy group.
', 'refs' => [ 'HierarchyGroups$Level1' => 'The group at level one of the agent hierarchy.
', 'HierarchyGroups$Level2' => 'The group at level two of the agent hierarchy.
', 'HierarchyGroups$Level3' => 'The group at level three of the agent hierarchy.
', 'HierarchyGroups$Level4' => 'The group at level four of the agent hierarchy.
', 'HierarchyGroups$Level5' => 'The group at level five of the agent hierarchy.
', ], ], 'AgentHierarchyGroups' => [ 'base' => 'A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
', 'refs' => [ 'SearchCriteria$AgentHierarchyGroups' => 'The agent hierarchy groups of the agent at the time of handling the contact.
', ], ], 'AgentInfo' => [ 'base' => 'Information about the agent who accepted the contact.
', 'refs' => [ 'Contact$AgentInfo' => 'Information about the agent who accepted the contact.
', ], ], 'AgentLastName' => [ 'base' => NULL, 'refs' => [ 'UserIdentityInfo$LastName' => 'The last name. This is required if you are using Amazon Connect or SAML for identity management.
', 'UserIdentityInfoLite$LastName' => 'The user\'s last name.
', ], ], 'AgentPauseDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'AgentInfo$AgentPauseDurationInSeconds' => 'Agent pause duration for a contact in seconds.
', ], ], 'AgentQualityMetrics' => [ 'base' => 'Information about the quality of the Agent\'s media connection
', 'refs' => [ 'QualityMetrics$Agent' => 'Information about the quality of Agent media connection.
', ], ], 'AgentResourceId' => [ 'base' => NULL, 'refs' => [ 'AgentInfo$Id' => 'The identifier of the agent who accepted the contact.
', 'AgentResourceIdList$member' => NULL, 'ContactSearchSummaryAgentInfo$Id' => 'The identifier of the agent who accepted the contact.
', 'GetFederationTokenResponse$UserId' => 'The identifier for the user. This can be the ID or the ARN of the user.
', 'MonitorContactRequest$UserId' => 'The identifier of the user account.
', 'TransferContactRequest$UserId' => 'The identifier for the user. This can be the ID or the ARN of the user.
', ], ], 'AgentResourceIdList' => [ 'base' => NULL, 'refs' => [ 'SearchCriteria$AgentIds' => 'The identifiers of agents who handled the contacts.
', ], ], 'AgentStatus' => [ 'base' => 'Contains information about an agent status.
', 'refs' => [ 'DescribeAgentStatusResponse$AgentStatus' => 'The agent status.
', ], ], 'AgentStatusDescription' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$Description' => 'The description of the agent status.
', 'CreateAgentStatusRequest$Description' => 'The description of the status.
', ], ], 'AgentStatusId' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$AgentStatusId' => 'The identifier of the agent status.
', 'AgentStatusSummary$Id' => 'The identifier for an agent status.
', 'CreateAgentStatusResponse$AgentStatusId' => 'The identifier of the agent status.
', 'DescribeAgentStatusRequest$AgentStatusId' => 'The identifier for the agent status.
', 'PutUserStatusRequest$AgentStatusId' => 'The identifier of the agent status.
', 'UpdateAgentStatusRequest$AgentStatusId' => 'The identifier of the agent status.
', ], ], 'AgentStatusName' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$Name' => 'The name of the agent status.
', 'AgentStatusReference$StatusName' => 'The name of the agent status.
', 'AgentStatusSummary$Name' => 'The name of the agent status.
', 'CreateAgentStatusRequest$Name' => 'The name of the status.
', 'UpdateAgentStatusRequest$Name' => 'The name of the agent status.
', 'UserData$NextStatus' => 'The Next status of the agent.
', ], ], 'AgentStatusOrderNumber' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$DisplayOrder' => 'The display order of the agent status.
', 'CreateAgentStatusRequest$DisplayOrder' => 'The display order of the status.
', 'UpdateAgentStatusRequest$DisplayOrder' => 'The display order of the agent status.
', ], ], 'AgentStatusReference' => [ 'base' => 'Information about the agent\'s status.
', 'refs' => [ 'UserData$Status' => 'The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
', ], ], 'AgentStatusState' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$State' => 'The state of the agent status.
', 'CreateAgentStatusRequest$State' => 'The state of the status.
', 'UpdateAgentStatusRequest$State' => 'The state of the agent status.
', ], ], 'AgentStatusSummary' => [ 'base' => 'Summary information for an agent status.
', 'refs' => [ 'AgentStatusSummaryList$member' => NULL, ], ], 'AgentStatusSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAgentStatusResponse$AgentStatusSummaryList' => 'A summary of agent statuses.
', ], ], 'AgentStatusType' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$Type' => 'The type of agent status.
', 'AgentStatusSummary$Type' => 'The type of the agent status.
', 'AgentStatusTypes$member' => NULL, ], ], 'AgentStatusTypes' => [ 'base' => NULL, 'refs' => [ 'ListAgentStatusRequest$AgentStatusTypes' => 'Available agent status types.
', ], ], 'AgentUsername' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Username' => 'The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+.
Username can include @ only if used in an email format. For example:
Correct: testuser
Correct: testuser@example.com
Incorrect: testuser@example
The user name assigned to the user account.
', 'UserSearchSummary$Username' => 'The name of the user.
', 'UserSummary$Username' => 'The Amazon Connect user name of the user account.
', ], ], 'AgentsMinOneMaxHundred' => [ 'base' => NULL, 'refs' => [ 'UserDataFilters$Agents' => 'A list of up to 100 agent IDs or ARNs.
', ], ], 'AliasArn' => [ 'base' => NULL, 'refs' => [ 'LexV2Bot$AliasArn' => 'The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
', ], ], 'AllowedAccessControlTags' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$AllowedAccessControlTags' => 'The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
', 'SecurityProfile$AllowedAccessControlTags' => 'The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
', 'UpdateSecurityProfileRequest$AllowedAccessControlTags' => 'The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
', ], ], 'AllowedCapabilities' => [ 'base' => 'Information about the capabilities enabled for participants of the contact.
', 'refs' => [ 'StartWebRTCContactRequest$AllowedCapabilities' => 'Information about the video sharing capabilities of the participants (customer, agent).
', ], ], 'AllowedMonitorCapabilities' => [ 'base' => NULL, 'refs' => [ 'MonitorContactRequest$AllowedMonitorCapabilities' => 'Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.
', ], ], 'AnalyticsDataAssociationResult' => [ 'base' => 'This API is in preview release for Amazon Connect and is subject to change.
Information about associations that are successfully created: DataSetId
, TargetAccountId
, ResourceShareId
, ResourceShareArn
.
Information about associations that are successfully created: DataSetId
, TargetAccountId
, ResourceShareId
, ResourceShareArn
.
An array of successful results: DataSetId
, TargetAccountId
, ResourceShareId
, ResourceShareArn
. This is a paginated API, so nextToken
is given if there are more results to be returned.
Configuration of the answering machine detection.
', 'refs' => [ 'StartOutboundVoiceContactRequest$AnswerMachineDetectionConfig' => 'Configuration of the answering machine detection for this outbound call.
', ], ], 'AnsweringMachineDetectionStatus' => [ 'base' => NULL, 'refs' => [ 'Contact$AnsweringMachineDetectionStatus' => 'Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
', ], ], 'Application' => [ 'base' => 'This API is in preview release for Amazon Connect and is subject to change.
A third-party application\'s metadata.
', 'refs' => [ 'Applications$member' => NULL, ], ], 'ApplicationPermissions' => [ 'base' => NULL, 'refs' => [ 'Application$ApplicationPermissions' => 'The permissions that the agent is granted on the application. Only the ACCESS
permission is supported.
A list of third-party applications that the security profile will give access to.
', 'ListSecurityProfileApplicationsResponse$Applications' => 'A list of the third-party application\'s metadata.
', 'UpdateSecurityProfileRequest$Applications' => 'A list of the third-party application\'s metadata.
', ], ], 'ApproximateTotalCount' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataResponse$ApproximateTotalCount' => 'The total count of the result, regardless of the current page size.
', 'GetCurrentUserDataResponse$ApproximateTotalCount' => 'The total count of the result, regardless of the current page size.
', 'SearchContactFlowModulesResponse$ApproximateTotalCount' => 'The total number of contact flows which matched your search query.
', 'SearchContactFlowsResponse$ApproximateTotalCount' => 'The total number of contact flows which matched your search query.
', 'SearchHoursOfOperationsResponse$ApproximateTotalCount' => 'The total number of hours of operations which matched your search query.
', 'SearchPredefinedAttributesResponse$ApproximateTotalCount' => 'The approximate number of predefined attributes which matched your search query.
', 'SearchPromptsResponse$ApproximateTotalCount' => 'The total number of quick connects which matched your search query.
', 'SearchQueuesResponse$ApproximateTotalCount' => 'The total number of queues which matched your search query.
', 'SearchQuickConnectsResponse$ApproximateTotalCount' => 'The total number of quick connects which matched your search query.
', 'SearchRoutingProfilesResponse$ApproximateTotalCount' => 'The total number of routing profiles which matched your search query.
', 'SearchSecurityProfilesResponse$ApproximateTotalCount' => 'The total number of security profiles which matched your search query.
', 'SearchUsersResponse$ApproximateTotalCount' => 'The total number of users who matched your search query.
', ], ], 'ArtifactId' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisAttachment$AttachmentId' => 'A unique identifier for the attachment.
', ], ], 'ArtifactStatus' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisAttachment$Status' => 'Status of the attachment.
', ], ], 'AssignContactCategoryActionDefinition' => [ 'base' => 'This action must be set if TriggerEventSource
is one of the following values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
. Contact is categorized using the rule name.
RuleName
is used as ContactCategory
.
Information about the contact category action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
The IDs of the associated queue.
', ], ], 'AssociationId' => [ 'base' => NULL, 'refs' => [ 'AssociateInstanceStorageConfigResponse$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'AssociateSecurityKeyResponse$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'DescribeInstanceStorageConfigRequest$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'DisassociateInstanceStorageConfigRequest$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'DisassociateSecurityKeyRequest$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'InstanceStorageConfig$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'SecurityKey$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'UpdateInstanceStorageConfigRequest$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', ], ], 'AttachedFile' => [ 'base' => 'Information about the attached file.
', 'refs' => [ 'AttachedFilesList$member' => NULL, ], ], 'AttachedFileError' => [ 'base' => 'Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
', 'refs' => [ 'AttachedFileErrorsList$member' => NULL, ], ], 'AttachedFileErrorsList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAttachedFileMetadataResponse$Errors' => 'List of errors of attached files that could not be retrieved.
', ], ], 'AttachedFileInvalidRequestExceptionReason' => [ 'base' => NULL, 'refs' => [ 'InvalidRequestExceptionReason$AttachedFileInvalidRequestExceptionReason' => 'Reason why the StartAttachedFiledUpload request was invalid.
', ], ], 'AttachedFilesList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAttachedFileMetadataResponse$Files' => 'List of attached files that were successfully retrieved.
', ], ], 'AttachmentName' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisAttachment$AttachmentName' => 'A case-sensitive name of the attachment being uploaded. Can be redacted.
', ], ], 'AttachmentReference' => [ 'base' => 'Information about a reference when the referenceType
is ATTACHMENT
. Otherwise, null.
Information about the reference when the referenceType
is ATTACHMENT
. Otherwise, null.
The attendee information, including attendee ID and join token.
', 'refs' => [ 'ConnectionData$Attendee' => 'The attendee information, including attendee ID and join token.
', ], ], 'AttendeeId' => [ 'base' => NULL, 'refs' => [ 'Attendee$AttendeeId' => 'The Amazon Chime SDK attendee ID.
', ], ], 'Attribute' => [ 'base' => 'A toggle for an individual feature at the instance level.
', 'refs' => [ 'AttributesList$member' => NULL, 'DescribeInstanceAttributeResponse$Attribute' => 'The type of attribute.
', ], ], 'AttributeAndCondition' => [ 'base' => 'A list of conditions which would be applied together with an AND
condition.
A list of conditions which would be applied together with an AND
condition.
An object to specify the predefined attribute condition.
', 'refs' => [ 'Expression$AttributeCondition' => 'An object to specify the predefined attribute condition.
', ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'Attributes$key' => NULL, ], ], 'AttributeOrConditionList' => [ 'base' => NULL, 'refs' => [ 'ControlPlaneUserAttributeFilter$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
List of attributes to be stored in a contact.
', 'GetContactAttributesResponse$Attributes' => 'Information about the attributes.
', 'NewSessionDetails$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'StartChatContactRequest$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'StartOutboundVoiceContactRequest$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'StartTaskContactRequest$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'StartWebRTCContactRequest$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.
', 'UpdateContactAttributesRequest$Attributes' => 'The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:
Remove unnecessary attributes by setting their values to empty.
If the attributes are only used in one flow and don\'t need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren\'t needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
The attribute types.
', ], ], 'AudioFeatures' => [ 'base' => 'Has audio-specific configurations as the operating parameter for Echo Reduction.
', 'refs' => [ 'MeetingFeaturesConfiguration$Audio' => 'The configuration settings for the audio features available to a meeting.
', ], ], 'AudioQualityMetricsInfo' => [ 'base' => 'Contains information for score and potential quality issues for Audio
', 'refs' => [ 'AgentQualityMetrics$Audio' => 'Information about the audio quality of the Agent
', 'CustomerQualityMetrics$Audio' => 'Information about the audio quality of the Customer
', ], ], 'AudioQualityScore' => [ 'base' => NULL, 'refs' => [ 'AudioQualityMetricsInfo$QualityScore' => 'Number measuring the estimated quality of the media connection.
', ], ], 'AutoAccept' => [ 'base' => NULL, 'refs' => [ 'UserPhoneConfig$AutoAccept' => 'The Auto accept setting.
', ], ], 'AvailableNumberSummary' => [ 'base' => 'Information about available phone numbers.
', 'refs' => [ 'AvailableNumbersList$member' => NULL, ], ], 'AvailableNumbersList' => [ 'base' => NULL, 'refs' => [ 'SearchAvailablePhoneNumbersResponse$AvailableNumbersList' => 'A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
', ], ], 'AwsRegion' => [ 'base' => NULL, 'refs' => [ 'Distribution$Region' => 'The Amazon Web Services Region where the traffic is distributed.
', 'ReplicateInstanceRequest$ReplicaRegion' => 'The Amazon Web Services Region where to replicate the Amazon Connect instance.
', 'SignInDistribution$Region' => 'The Amazon Web Services Region of the sign in distribution.
', ], ], 'BatchAssociateAnalyticsDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchAssociateAnalyticsDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateAnalyticsDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateAnalyticsDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetAttachedFileMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetAttachedFileMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetFlowAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetFlowAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'BehaviorType' => [ 'base' => NULL, 'refs' => [ 'CrossChannelBehavior$BehaviorType' => 'Specifies the other channels that can be routed to an agent handling their current channel.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AnswerMachineDetectionConfig$EnableAnswerMachineDetection' => 'The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true
, TrafficType
must be set as CAMPAIGN
.
Wait for the answering machine prompt.
', 'EvaluationAnswerData$NotApplicable' => 'The flag to mark the question as not applicable.
', 'EvaluationFormNumericQuestionOption$AutomaticFail' => 'The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
', 'EvaluationFormQuestion$NotApplicableEnabled' => 'The flag to enable not applicable answers to the question.
', 'EvaluationFormSingleSelectQuestionOption$AutomaticFail' => 'The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
', 'EvaluationScore$NotApplicable' => 'The flag to mark the item as not applicable for scoring.
', 'EvaluationScore$AutomaticFail' => 'The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
', 'FieldValueUnion$BooleanValue' => 'A Boolean number value type.
', 'MetricFilterV2$Negate' => 'The flag to use to filter on requested metric filter values or to not filter on requested metric filter values. By default the negate is false
, which indicates to filter on the requested metric filter.
Whether this a default routing profile.
', 'SignInDistribution$Enabled' => 'Whether sign in distribution is enabled.
', 'TrafficDistributionGroup$IsDefault' => 'Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup
API. The default traffic distribution group is deleted as part of the process for deleting a replica.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup
API. The default traffic distribution group is deleted as part of the process for deleting a replica.
A number indicating the reset order of the agent status.
', ], ], 'BotName' => [ 'base' => NULL, 'refs' => [ 'DisassociateLexBotRequest$BotName' => 'The name of the Amazon Lex bot. Maximum character limit of 50.
', 'LexBot$Name' => 'The name of the Amazon Lex bot.
', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'UpdateEvaluationFormRequest$CreateNewVersion' => 'A flag indicating whether the operation must create a new version.
', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Config$BucketName' => 'The S3 bucket name.
', ], ], 'Campaign' => [ 'base' => 'Information associated with a campaign.
', 'refs' => [ 'Contact$Campaign' => NULL, 'ContactDataRequest$Campaign' => 'Structure to store information associated with a campaign.
', ], ], 'CampaignId' => [ 'base' => NULL, 'refs' => [ 'Campaign$CampaignId' => 'A unique identifier for a campaign.
', 'StartOutboundVoiceContactRequest$CampaignId' => 'The campaign identifier of the outbound communication.
', ], ], 'Channel' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$Channel' => 'The channel of the contact.
', 'ChannelList$member' => NULL, 'ChannelToCountMap$key' => NULL, 'Channels$member' => NULL, 'Contact$Channel' => 'How the contact reached your contact center.
', 'ContactSearchSummary$Channel' => 'How the contact reached your contact center.
', 'Dimensions$Channel' => 'The channel used for grouping and filters.
', 'MediaConcurrency$Channel' => 'The channels that agents can handle in the Contact Control Panel (CCP).
', 'RoutingProfileQueueConfigSummary$Channel' => 'The channels this queue supports.
', 'RoutingProfileQueueReference$Channel' => 'The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
', ], ], 'ChannelList' => [ 'base' => NULL, 'refs' => [ 'SearchCriteria$Channels' => 'The list of channels associated with contacts.
', ], ], 'ChannelToCountMap' => [ 'base' => NULL, 'refs' => [ 'UserData$AvailableSlotsByChannel' => 'A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
', 'UserData$MaxSlotsByChannel' => 'A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile
assigned to the agent.
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
', ], ], 'Channels' => [ 'base' => NULL, 'refs' => [ 'Filters$Channels' => 'The channel to use to filter the metrics.
', ], ], 'ChatContent' => [ 'base' => NULL, 'refs' => [ 'ChatEvent$Content' => 'Content of the message or event. This is required when Type
is MESSAGE
and for certain ContentTypes
when Type
is EVENT
.
For allowed message content, see the Content
parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
For allowed event content, see the Content
parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
The content of the chat message.
For text/plain
and text/markdown
, the Length Constraints are Minimum of 1, Maximum of 1024.
For application/json
, the Length Constraints are Minimum of 1, Maximum of 12000.
For application/vnd.amazonaws.connect.message.interactive.response
, the Length Constraints are Minimum of 1, Maximum of 12288.
Type of content. This is required when Type
is MESSAGE
or EVENT
.
For allowed message content types, see the ContentType
parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
For allowed event content types, see the ContentType
parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
The type of the content. Supported types are text/plain
, text/markdown
, application/json
, and application/vnd.amazonaws.connect.message.interactive.response
.
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
', ], ], 'ChatEvent' => [ 'base' => 'Chat integration event containing payload to perform different chat actions such as:
Sending a chat message
Sending a chat event, such as typing
Disconnecting from a chat
Chat integration event payload
', ], ], 'ChatEventType' => [ 'base' => NULL, 'refs' => [ 'ChatEvent$Type' => 'Type of chat integration event.
', ], ], 'ChatMessage' => [ 'base' => 'A chat message.
', 'refs' => [ 'StartChatContactRequest$InitialMessage' => 'The initial message to be sent to the newly created chat. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.
', ], ], 'ChatParticipantRoleConfig' => [ 'base' => 'Configuration information for the chat participant role.
', 'refs' => [ 'UpdateParticipantRoleConfigChannelInfo$Chat' => 'Configuration information for the chat participant role.
', ], ], 'ChatStreamingConfiguration' => [ 'base' => 'The streaming configuration, such as the Amazon SNS streaming endpoint.
', 'refs' => [ 'NewSessionDetails$StreamingConfiguration' => NULL, 'StartContactStreamingRequest$ChatStreamingConfiguration' => 'The streaming configuration, such as the Amazon SNS streaming endpoint.
', ], ], 'ChatStreamingEndpointARN' => [ 'base' => NULL, 'refs' => [ 'ChatStreamingConfiguration$StreamingEndpointArn' => 'The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.
', ], ], 'ClaimPhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ClaimPhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'ClaimedPhoneNumberSummary' => [ 'base' => 'Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
', 'refs' => [ 'DescribePhoneNumberResponse$ClaimedPhoneNumberSummary' => 'Information about a phone number that\'s been claimed to your Amazon Connect instance or traffic distribution group.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'BatchPutContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'ClaimPhoneNumberRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateEvaluationFormRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateInstanceRequest$ClientToken' => 'The idempotency token.
', 'CreateParticipantRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreatePersistentContactAssociationRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateRuleRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateTaskTemplateRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateTrafficDistributionGroupRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateVocabularyRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
', 'ImportPhoneNumberRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'MonitorContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'ReleasePhoneNumberRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'ReplicateInstanceRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartAttachedFileUploadRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartChatContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartContactEvaluationRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartContactStreamingRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartOutboundVoiceContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
', 'StartTaskContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartWebRTCContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
', 'TransferContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'UpdateEvaluationFormRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'UpdatePhoneNumberMetadataRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'UpdatePhoneNumberRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', ], ], 'CommonNameLength127' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationRequest$Name' => 'The name of the hours of operation.
', 'CreatePromptRequest$Name' => 'The name of the prompt.
', 'CreateQueueRequest$Name' => 'The name of the queue.
', 'HoursOfOperation$Name' => 'The name for the hours of operation.
', 'Prompt$Name' => 'The name of the prompt.
', 'Queue$Name' => 'The name of the queue.
', 'UpdateHoursOfOperationRequest$Name' => 'The name of the hours of operation.
', 'UpdatePromptRequest$Name' => 'The name of the prompt.
', 'UpdateQueueNameRequest$Name' => 'The name of the queue.
', ], ], 'Comparison' => [ 'base' => NULL, 'refs' => [ 'Threshold$Comparison' => 'The type of comparison. Only "less than" (LT) comparisons are supported.
', ], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'AttributeCondition$ComparisonOperator' => 'The operator of the condition.
', ], ], 'CompleteAttachedFileUploadRequest' => [ 'base' => 'Request to CompleteAttachedFileUpload API', 'refs' => [], ], 'CompleteAttachedFileUploadResponse' => [ 'base' => 'Response from CompleteAttachedFileUpload API', 'refs' => [], ], 'Concurrency' => [ 'base' => NULL, 'refs' => [ 'MediaConcurrency$Concurrency' => 'The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE
: Minimum value of 1. Maximum value of 1.
Valid Range for CHAT
: Minimum value of 1. Maximum value of 10.
Valid Range for TASK
: Minimum value of 1. Maximum value of 10.
Operation cannot be performed at this time as there is a conflict with another operation or contact state.
', 'refs' => [], ], 'ConnectionData' => [ 'base' => 'Information required to join the call.
', 'refs' => [ 'StartWebRTCContactResponse$ConnectionData' => 'Information required for the client application (mobile application or website) to connect to the call.
', ], ], 'Contact' => [ 'base' => 'Contains information about a contact.
', 'refs' => [ 'DescribeContactResponse$Contact' => 'Information about the contact.
', ], ], 'ContactAnalysis' => [ 'base' => 'A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
', 'refs' => [ 'SearchCriteria$ContactAnalysis' => 'Search criteria based on analysis outputs from Amazon Connect Contact Lens.
', ], ], 'ContactDataRequest' => [ 'base' => 'Request object with information to create a contact.
', 'refs' => [ 'ContactDataRequestList$member' => NULL, ], ], 'ContactDataRequestList' => [ 'base' => NULL, 'refs' => [ 'BatchPutContactRequest$ContactDataRequestList' => 'List of individual contact requests.
', ], ], 'ContactFilter' => [ 'base' => 'Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
', 'refs' => [ 'UserDataFilters$ContactFilter' => 'A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.
', ], ], 'ContactFlow' => [ 'base' => 'Contains information about a flow.
', 'refs' => [ 'ContactFlowSearchSummaryList$member' => NULL, 'DescribeContactFlowResponse$ContactFlow' => 'Information about the flow.
', ], ], 'ContactFlowContent' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
', 'CreateContactFlowRequest$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
', 'UpdateContactFlowContentRequest$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
', ], ], 'ContactFlowDescription' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Description' => 'The description of the flow.
', 'CreateContactFlowRequest$Description' => 'The description of the flow.
', 'UpdateContactFlowMetadataRequest$Description' => 'The description of the flow.
', 'UpdateContactFlowNameRequest$Description' => 'The description of the flow.
', ], ], 'ContactFlowId' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumberContactFlowRequest$ContactFlowId' => 'The identifier of the flow.
', 'ContactFlow$Id' => 'The identifier of the flow.
', 'ContactFlowSummary$Id' => 'The identifier of the flow.
', 'CreateContactFlowResponse$ContactFlowId' => 'The identifier of the flow.
', 'CreateTaskTemplateRequest$ContactFlowId' => 'The identifier of the flow that runs by default when a task is created by referencing this template.
', 'DeleteContactFlowRequest$ContactFlowId' => 'The identifier of the flow.
', 'DescribeContactFlowRequest$ContactFlowId' => 'The identifier of the flow.
', 'GetTaskTemplateResponse$ContactFlowId' => 'The identifier of the flow that runs by default when a task is created by referencing this template.
', 'OutboundCallerConfig$OutboundFlowId' => 'The outbound whisper flow to be used during an outbound call.
', 'PauseContactRequest$ContactFlowId' => 'The identifier of the flow.
', 'QueueQuickConnectConfig$ContactFlowId' => 'The identifier of the flow.
', 'ResumeContactRequest$ContactFlowId' => 'The identifier of the flow.
', 'StartChatContactRequest$ContactFlowId' => 'The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
', 'StartOutboundVoiceContactRequest$ContactFlowId' => 'The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
', 'StartTaskContactRequest$ContactFlowId' => 'The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
', 'StartWebRTCContactRequest$ContactFlowId' => 'The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
', 'TaskActionDefinition$ContactFlowId' => 'The identifier of the flow.
', 'TransferContactRequest$ContactFlowId' => 'The identifier of the flow.
', 'UpdateContactFlowContentRequest$ContactFlowId' => 'The identifier of the flow.
', 'UpdateContactFlowMetadataRequest$ContactFlowId' => 'The identifier of the flow.
', 'UpdateContactFlowNameRequest$ContactFlowId' => 'The identifier of the flow.
', 'UpdateTaskTemplateRequest$ContactFlowId' => 'The identifier of the flow that runs by default when a task is created by referencing this template.
', 'UpdateTaskTemplateResponse$ContactFlowId' => 'The identifier of the flow that runs by default when a task is created by referencing this template.
', 'UserQuickConnectConfig$ContactFlowId' => 'The identifier of the flow.
', ], ], 'ContactFlowModule' => [ 'base' => 'Contains information about a flow module.
', 'refs' => [ 'ContactFlowModuleSearchSummaryList$member' => NULL, 'DescribeContactFlowModuleResponse$ContactFlowModule' => 'Information about the flow module.
', ], ], 'ContactFlowModuleContent' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
', 'CreateContactFlowModuleRequest$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
', 'UpdateContactFlowModuleContentRequest$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
', ], ], 'ContactFlowModuleDescription' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Description' => 'The description of the flow module.
', 'CreateContactFlowModuleRequest$Description' => 'The description of the flow module.
', 'UpdateContactFlowModuleMetadataRequest$Description' => 'The description of the flow module.
', ], ], 'ContactFlowModuleId' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Id' => 'The identifier of the flow module.
', 'ContactFlowModuleSummary$Id' => 'The identifier of the flow module.
', 'CreateContactFlowModuleResponse$Id' => 'The identifier of the flow module.
', 'DeleteContactFlowModuleRequest$ContactFlowModuleId' => 'The identifier of the flow module.
', 'DescribeContactFlowModuleRequest$ContactFlowModuleId' => 'The identifier of the flow module.
', 'UpdateContactFlowModuleContentRequest$ContactFlowModuleId' => 'The identifier of the flow module.
', 'UpdateContactFlowModuleMetadataRequest$ContactFlowModuleId' => 'The identifier of the flow module.
', ], ], 'ContactFlowModuleName' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Name' => 'The name of the flow module.
', 'ContactFlowModuleSummary$Name' => 'The name of the flow module.
', 'CreateContactFlowModuleRequest$Name' => 'The name of the flow module.
', 'UpdateContactFlowModuleMetadataRequest$Name' => 'The name of the flow module.
', ], ], 'ContactFlowModuleSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModuleSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return flow modules.
', 'refs' => [ 'ContactFlowModuleSearchConditionList$member' => NULL, 'SearchContactFlowModulesRequest$SearchCriteria' => 'The search criteria to be used to return contact flow modules.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
The search criteria to be used to return flow modules.
', 'refs' => [ 'SearchContactFlowModulesRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'ContactFlowModuleSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchContactFlowModulesResponse$ContactFlowModules' => 'The search criteria to be used to return contact flow modules.
', ], ], 'ContactFlowModuleState' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$State' => 'The type of flow module.
', 'ContactFlowModuleSummary$State' => 'The type of flow module.
', 'ListContactFlowModulesRequest$ContactFlowModuleState' => 'The state of the flow module.
', 'UpdateContactFlowModuleMetadataRequest$State' => 'The state of flow module.
', ], ], 'ContactFlowModuleStatus' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Status' => 'The status of the flow module.
', ], ], 'ContactFlowModuleSummary' => [ 'base' => 'Contains summary information about a flow.
', 'refs' => [ 'ContactFlowModulesSummaryList$member' => NULL, ], ], 'ContactFlowModulesSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListContactFlowModulesResponse$ContactFlowModulesSummaryList' => 'Information about the flow module.
', ], ], 'ContactFlowName' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Name' => 'The name of the flow.
', 'ContactFlowSummary$Name' => 'The name of the flow.
', 'CreateContactFlowRequest$Name' => 'The name of the flow.
', 'UpdateContactFlowMetadataRequest$Name' => 'The name of the flow.
', 'UpdateContactFlowNameRequest$Name' => 'The name of the flow.
', ], ], 'ContactFlowNotPublishedException' => [ 'base' => 'The flow has not been published.
', 'refs' => [], ], 'ContactFlowSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'ContactFlowSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return contact flows.
', 'refs' => [ 'ContactFlowSearchConditionList$member' => NULL, 'SearchContactFlowsRequest$SearchCriteria' => 'The search criteria to be used to return flows.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Filters to be applied to search results.
', 'refs' => [ 'SearchContactFlowsRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'ContactFlowSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchContactFlowsResponse$ContactFlows' => 'Information about the contact flows.
', ], ], 'ContactFlowState' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$State' => 'The type of flow.
', 'ContactFlowSearchCriteria$StateCondition' => 'The state of the flow.
', 'ContactFlowSummary$ContactFlowState' => 'The type of flow.
', 'UpdateContactFlowMetadataRequest$ContactFlowState' => 'The state of flow.
', ], ], 'ContactFlowStatus' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Status' => 'The status of the contact flow.
', 'ContactFlowSearchCriteria$StatusCondition' => 'The status of the flow.
', 'ContactFlowSummary$ContactFlowStatus' => 'The status of the contact flow.
', 'CreateContactFlowRequest$Status' => 'Indicates the flow status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content. the SAVED
status does not initiate validation of the content. SAVED
| PUBLISHED
.
Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
', 'refs' => [ 'ContactFlowSummaryList$member' => NULL, ], ], 'ContactFlowSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListContactFlowsResponse$ContactFlowSummaryList' => 'Information about the flows.
', ], ], 'ContactFlowType' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Type' => 'The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
', 'ContactFlowSearchCriteria$TypeCondition' => 'The type of flow.
', 'ContactFlowSummary$ContactFlowType' => 'The type of flow.
', 'ContactFlowTypes$member' => NULL, 'CreateContactFlowRequest$Type' => 'The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
', ], ], 'ContactFlowTypes' => [ 'base' => NULL, 'refs' => [ 'ListContactFlowsRequest$ContactFlowTypes' => 'The type of flow.
', ], ], 'ContactId' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'Contact$Id' => 'The identifier for the contact.
', 'Contact$InitialContactId' => 'If this contact is related to other contacts, this is the ID of the initial contact.
', 'Contact$PreviousContactId' => 'If this contact is not the first contact, this is the ID of the previous contact.
', 'Contact$RelatedContactId' => 'The contactId that is related to this contact.
', 'ContactSearchSummary$Id' => 'The identifier of the contact summary.
', 'ContactSearchSummary$InitialContactId' => 'If this contact is related to other contacts, this is the ID of the initial contact.
', 'ContactSearchSummary$PreviousContactId' => 'If this contact is not the first contact, this is the ID of the previous contact.
', 'CreateParticipantRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.
', 'CreatePersistentContactAssociationRequest$InitialContactId' => 'This is the contactId of the current contact that the CreatePersistentContactAssociation
API is being called from.
The contactId from which a persistent chat session must be started.
', 'CreatePersistentContactAssociationResponse$ContinuedFromContactId' => 'The contactId from which a persistent chat session is started. This field is populated only for persistent chat.
', 'DescribeContactRequest$ContactId' => 'The identifier of the contact.
', 'DismissUserContactRequest$ContactId' => 'The identifier of the contact.
', 'EvaluationMetadata$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'GetContactAttributesRequest$InitialContactId' => 'The identifier of the initial contact.
', 'ListContactEvaluationsRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'ListContactReferencesRequest$ContactId' => 'The identifier of the initial contact.
', 'ListRealtimeContactAnalysisSegmentsV2Request$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'MonitorContactRequest$ContactId' => 'The identifier of the contact.
', 'MonitorContactResponse$ContactId' => 'The identifier of the contact.
', 'PauseContactRequest$ContactId' => 'The identifier of the contact.
', 'PersistentChat$SourceContactId' => 'The contactId from which a persistent chat session must be started.
', 'ResumeContactRecordingRequest$ContactId' => 'The identifier of the contact.
', 'ResumeContactRecordingRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'ResumeContactRequest$ContactId' => 'The identifier of the contact.
', 'SendChatIntegrationEventResponse$InitialContactId' => 'Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact.
', 'StartChatContactRequest$RelatedContactId' => 'The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.
You cannot provide data for both RelatedContactId and PersistentChat.
The identifier of this contact within the Amazon Connect instance.
', 'StartChatContactResponse$ContinuedFromContactId' => 'The contactId from which a persistent chat session is started. This field is populated only for persistent chats.
', 'StartContactEvaluationRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'StartContactRecordingRequest$ContactId' => 'The identifier of the contact.
', 'StartContactRecordingRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'StartContactStreamingRequest$ContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'StartOutboundVoiceContactRequest$RelatedContactId' => 'The contactId
that is related to this contact. Linking voice, task, or chat by using RelatedContactID
copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId
.
The identifier of this contact within the Amazon Connect instance.
', 'StartTaskContactRequest$PreviousContactId' => 'The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID
will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.
The contactId that is related to this contact. Linking tasks together by using RelatedContactID
copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID
. There are no limits to the number of contacts that can be linked by using RelatedContactId
.
The identifier of this contact within the Amazon Connect instance.
', 'StartWebRTCContactRequest$RelatedContactId' => 'The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
', 'StartWebRTCContactResponse$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'StopContactRecordingRequest$ContactId' => 'The identifier of the contact.
', 'StopContactRecordingRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'StopContactRequest$ContactId' => 'The ID of the contact.
', 'StopContactStreamingRequest$ContactId' => 'The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.
', 'SuccessfulRequest$ContactId' => 'The contactId of the contact that was created successfully.
', 'SuspendContactRecordingRequest$ContactId' => 'The identifier of the contact.
', 'SuspendContactRecordingRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'TagContactRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'TransferContactRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'TransferContactResponse$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'UntagContactRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'UpdateContactAttributesRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'UpdateContactRequest$ContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
', 'UpdateContactRoutingDataRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'UpdateContactScheduleRequest$ContactId' => 'The identifier of the contact.
', 'UpdateParticipantRoleConfigRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', ], ], 'ContactInitiationMethod' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$InitiationMethod' => 'How the contact was initiated.
', 'Contact$InitiationMethod' => 'Indicates how the contact was initiated.
', 'ContactSearchSummary$InitiationMethod' => 'Indicates how the contact was initiated.
', 'InitiationMethodList$member' => NULL, ], ], 'ContactNotFoundException' => [ 'base' => 'The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
', 'refs' => [], ], 'ContactReferences' => [ 'base' => NULL, 'refs' => [ 'StartOutboundVoiceContactRequest$References' => 'A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during voice contact creation.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during task creation.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during task creation.
Information about the reference when the referenceType
is URL
. Otherwise, null. (Supports variable injection in the Value
field.)
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
', ], ], 'ContactSearchSummary' => [ 'base' => 'Information of returned contact.
', 'refs' => [ 'Contacts$member' => NULL, ], ], 'ContactSearchSummaryAgentInfo' => [ 'base' => 'Information about the agent who accepted the contact.
', 'refs' => [ 'ContactSearchSummary$AgentInfo' => 'Information about the agent who accepted the contact.
', ], ], 'ContactSearchSummaryQueueInfo' => [ 'base' => 'If this contact was queued, this contains information about the queue.
', 'refs' => [ 'ContactSearchSummary$QueueInfo' => 'If this contact was queued, this contains information about the queue.
', ], ], 'ContactState' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$AgentContactState' => 'The state of the contact.
When AgentContactState
is set to CONNECTED_ONHOLD
, StateStartTimestamp
is not changed. Instead, StateStartTimestamp
reflects the time the contact was CONNECTED
to the agent.
A list of up to 9 contact states.
', ], ], 'ContactTagKey' => [ 'base' => NULL, 'refs' => [ 'ContactTagKeys$member' => NULL, 'ContactTagMap$key' => NULL, ], ], 'ContactTagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagContactRequest$TagKeys' => 'A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.
', ], ], 'ContactTagMap' => [ 'base' => NULL, 'refs' => [ 'Contact$Tags' => 'Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
', 'TagContactRequest$Tags' => 'The tags to be assigned to the contact resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Authorization is not supported by this tag.
Information about the contacts.
', ], ], 'Content' => [ 'base' => NULL, 'refs' => [ 'SendNotificationActionDefinition$Content' => 'Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisAttachment$ContentType' => 'Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
', ], ], 'ControlPlaneTagFilter' => [ 'base' => 'An object that can be used to specify Tag conditions inside the SearchFilter
. This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
operator
Inner list specifies conditions that need to be applied with AND
operator.
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter
.
This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
operator
The inner list specifies conditions that need to be applied with AND
operator.
Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum number of allowed Hierarchy Group conditions is 20.
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.
This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
operator.
The inner list specifies conditions that need to be applied with AND
operator.
Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.
The CreateCase
action definition.
Information about the create case action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnPostChatAnalysisAvailable
.
The name of the security profile.
', ], ], 'CreateSecurityProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSecurityProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTaskTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTaskTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrafficDistributionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrafficDistributionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUseCaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUseCaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserHierarchyGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserHierarchyGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateViewRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateViewResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateViewVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateViewVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVocabularyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVocabularyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedByInfo' => [ 'base' => 'Information on the identity that created the file.
', 'refs' => [ 'AttachedFile$CreatedBy' => 'Represents the identity that created the file.
', 'GetAttachedFileResponse$CreatedBy' => 'Represents the identity that created the file.
', 'StartAttachedFileUploadRequest$CreatedBy' => 'Represents the identity that created the file.
', 'StartAttachedFileUploadResponse$CreatedBy' => 'Represents the identity that created the file.
', ], ], 'Credentials' => [ 'base' => 'Contains credentials to use for federation.
', 'refs' => [ 'GetFederationTokenResponse$Credentials' => 'The credentials to use for federation.
', ], ], 'CrossChannelBehavior' => [ 'base' => 'Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.
', 'refs' => [ 'MediaConcurrency$CrossChannelBehavior' => 'Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.
', ], ], 'CurrentMetric' => [ 'base' => 'Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
', 'refs' => [ 'CurrentMetricData$Metric' => 'Information about the metric.
', 'CurrentMetrics$member' => NULL, ], ], 'CurrentMetricData' => [ 'base' => 'Contains the data for a real-time metric.
', 'refs' => [ 'CurrentMetricDataCollections$member' => NULL, ], ], 'CurrentMetricDataCollections' => [ 'base' => NULL, 'refs' => [ 'CurrentMetricResult$Collections' => 'The set of metrics.
', ], ], 'CurrentMetricName' => [ 'base' => 'The current metric names.
', 'refs' => [ 'CurrentMetric$Name' => 'The name of the metric.
', 'CurrentMetricSortCriteria$SortByMetric' => NULL, ], ], 'CurrentMetricResult' => [ 'base' => 'Contains information about a set of real-time metrics.
', 'refs' => [ 'CurrentMetricResults$member' => NULL, ], ], 'CurrentMetricResults' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataResponse$MetricResults' => 'Information about the real-time metrics.
', ], ], 'CurrentMetricSortCriteria' => [ 'base' => 'The way to sort the resulting response based on metrics. By default resources are sorted based on AGENTS_ONLINE
, DESCENDING
. The metric collection is sorted based on the input metrics.
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE
, DESCENDING
. The metric collection is sorted based on the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE
and SLOTS_AVAILABLE
is not supported.
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
}
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression
is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1>
for 10 seconds has expired and <Expression 2>
becomes active, then OLDEST_CONTACT_AGE
for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
Information about the Customer on the contact.
', 'refs' => [ 'Contact$Customer' => 'Information about the Customer on the contact.
', ], ], 'CustomerQualityMetrics' => [ 'base' => 'Information about the quality of the Customer\'s media connection
', 'refs' => [ 'QualityMetrics$Customer' => 'Information about the quality of Customer media connection.
', ], ], 'CustomerVoiceActivity' => [ 'base' => 'Information about customer’s voice activity.
', 'refs' => [ 'Contact$CustomerVoiceActivity' => 'Information about customer’s voice activity.
', ], ], 'DataSetId' => [ 'base' => NULL, 'refs' => [ 'AnalyticsDataAssociationResult$DataSetId' => 'The identifier of the dataset.
', 'AssociateAnalyticsDataSetRequest$DataSetId' => 'The identifier of the dataset to associate with the target account.
', 'AssociateAnalyticsDataSetResponse$DataSetId' => 'The identifier of the dataset that was associated.
', 'DataSetIds$member' => NULL, 'DisassociateAnalyticsDataSetRequest$DataSetId' => 'The identifier of the dataset to remove.
', 'ListAnalyticsDataAssociationsRequest$DataSetId' => 'The identifier of the dataset to get the association status.
', ], ], 'DataSetIds' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateAnalyticsDataSetRequest$DataSetIds' => 'An array of dataset identifiers to associate.
', 'BatchDisassociateAnalyticsDataSetRequest$DataSetIds' => 'An array of associated dataset identifiers to remove.
', 'BatchDisassociateAnalyticsDataSetResponse$Deleted' => 'An array of successfully disassociated dataset identifiers.
', ], ], 'DateReference' => [ 'base' => 'Information about a reference when the referenceType
is DATE
. Otherwise, null.
Information about a reference when the referenceType
is DATE
. Otherwise, null.
Contains information about a default vocabulary.
', 'refs' => [ 'DefaultVocabularyList$member' => NULL, ], ], 'DefaultVocabularyList' => [ 'base' => NULL, 'refs' => [ 'ListDefaultVocabulariesResponse$DefaultVocabularyList' => 'A list of default vocabularies.
', ], ], 'Delay' => [ 'base' => NULL, 'refs' => [ 'RoutingProfileQueueConfig$Delay' => 'The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.
', 'RoutingProfileQueueConfigSummary$Delay' => 'The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.
', ], ], 'DeleteAttachedFileRequest' => [ 'base' => 'Request to DeleteAttachedFile API', 'refs' => [], ], 'DeleteAttachedFileResponse' => [ 'base' => 'Response from DeleteAttachedFile API', 'refs' => [], ], 'DeleteContactEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactFlowModuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactFlowModuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEvaluationFormRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHoursOfOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIntegrationAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePredefinedAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePromptRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteQueueRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteQuickConnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoutingProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrafficDistributionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrafficDistributionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUseCaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserHierarchyGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteViewRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteViewResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteViewVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteViewVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVocabularyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVocabularyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAgentStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAgentStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactFlowModuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactFlowModuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEvaluationFormRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEvaluationFormResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHoursOfOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHoursOfOperationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceAttributeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceStorageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceStorageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePredefinedAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePredefinedAttributeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePromptRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePromptResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQueueRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQueueResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQuickConnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQuickConnectResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRoutingProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRoutingProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrafficDistributionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrafficDistributionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserHierarchyGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserHierarchyGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserHierarchyStructureRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserHierarchyStructureResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeViewRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeViewResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVocabularyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVocabularyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'Contact$Description' => 'The description of the contact.
', 'StartOutboundVoiceContactRequest$Description' => 'A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
', 'StartTaskContactRequest$Description' => 'A description of the task that is shown to an agent in the Contact Control Panel (CCP).
', 'StartWebRTCContactRequest$Description' => 'A description of the task that is shown to an agent in the Contact Control Panel (CCP).
', 'UpdateContactRequest$Description' => 'The description of the contact.
', ], ], 'Description250' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupRequest$Description' => 'A description for the traffic distribution group.
', 'TrafficDistributionGroup$Description' => 'The description of the traffic distribution group.
', ], ], 'DestinationId' => [ 'base' => NULL, 'refs' => [ 'SendChatIntegrationEventRequest$DestinationId' => 'Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.
', ], ], 'DestinationNotAllowedException' => [ 'base' => 'Outbound calls to the destination number are not allowed.
', 'refs' => [], ], 'DeviceInfo' => [ 'base' => 'Information regarding the device.
', 'refs' => [ 'AgentInfo$DeviceInfo' => 'Information regarding Agent’s device.
', 'Customer$DeviceInfo' => 'Information regarding Customer’s device.
', ], ], 'Dimensions' => [ 'base' => 'Contains information about the dimensions for a set of metrics.
', 'refs' => [ 'CurrentMetricResult$Dimensions' => 'The dimensions for the metrics.
', 'HistoricalMetricResult$Dimensions' => 'The dimension for the metrics.
', ], ], 'DimensionsV2Key' => [ 'base' => NULL, 'refs' => [ 'DimensionsV2Map$key' => NULL, ], ], 'DimensionsV2Map' => [ 'base' => NULL, 'refs' => [ 'MetricResultV2$Dimensions' => 'The dimension for the metrics.
', ], ], 'DimensionsV2Value' => [ 'base' => NULL, 'refs' => [ 'DimensionsV2Map$value' => NULL, ], ], 'DirectoryAlias' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceRequest$InstanceAlias' => 'The name for your instance.
', 'Instance$InstanceAlias' => 'The alias of instance.
', 'InstanceSummary$InstanceAlias' => 'The alias of the instance.
', 'ReplicateInstanceRequest$ReplicaAlias' => 'The alias for the replicated instance. The ReplicaAlias
must be unique.
The identifier for the directory.
', ], ], 'DirectoryType' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceRequest$IdentityManagementType' => 'The type of identity management for your Amazon Connect users.
', 'Instance$IdentityManagementType' => 'The identity management type.
', 'InstanceSummary$IdentityManagementType' => 'The identity management type of the instance.
', ], ], 'DirectoryUserId' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$DirectoryUserId' => 'The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.
This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
', 'User$DirectoryUserId' => 'The identifier of the user account in the directory used for identity management.
', 'UserSearchSummary$DirectoryUserId' => 'The directory identifier of the user.
', ], ], 'DisassociateAnalyticsDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateApprovedOriginRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateBotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateInstanceStorageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateLambdaFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateLexBotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumberContactFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateQueueQuickConnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateRoutingProfileQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateSecurityKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTrafficDistributionGroupUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTrafficDistributionGroupUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateUserProficienciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisconnectDetails' => [ 'base' => 'Information about the call disconnect experience.
', 'refs' => [ 'Contact$DisconnectDetails' => 'Information about the call disconnect experience.
', ], ], 'DisconnectReason' => [ 'base' => 'Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
', 'refs' => [ 'StopContactRequest$DisconnectReason' => 'The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field.
', ], ], 'DisconnectReasonCode' => [ 'base' => NULL, 'refs' => [ 'DisconnectReason$Code' => 'A code that indicates how the contact was terminated.
', ], ], 'DismissUserContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DismissUserContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisplayName' => [ 'base' => NULL, 'refs' => [ 'ParticipantDetails$DisplayName' => 'Display name of the participant.
', 'ParticipantDetailsToAdd$DisplayName' => 'The display name of the participant.
', 'RealTimeContactAnalysisSegmentAttachments$DisplayName' => 'The display name of the participant. Can be redacted.
', 'RealTimeContactAnalysisSegmentEvent$DisplayName' => 'The display name of the participant. Can be redacted.
', 'RealTimeContactAnalysisSegmentTranscript$DisplayName' => 'The display name of the participant.
', ], ], 'Distribution' => [ 'base' => 'Information about a traffic distribution.
', 'refs' => [ 'DistributionList$member' => NULL, ], ], 'DistributionList' => [ 'base' => NULL, 'refs' => [ 'AgentConfig$Distributions' => 'Information about traffic distributions.
', 'TelephonyConfig$Distributions' => 'Information about traffic distributions.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'FieldValueUnion$DoubleValue' => 'a Double number value type.
', ], ], 'DownloadUrlMetadata' => [ 'base' => 'Metadata used to download the attached file.
', 'refs' => [ 'GetAttachedFileResponse$DownloadUrlMetadata' => 'URL and expiry to be used when downloading the attached file.
', ], ], 'DuplicateResourceException' => [ 'base' => 'A resource with the specified name already exists.
', 'refs' => [], ], 'DurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Expiry$DurationInSeconds' => 'The number of seconds to wait before expiring the routing step.
', ], ], 'Email' => [ 'base' => NULL, 'refs' => [ 'UserIdentityInfo$Email' => 'The email address. If you are using SAML for identity management and include this parameter, an error is returned.
', 'UserIdentityInfo$SecondaryEmail' => 'The user\'s secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.
Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}
Information about a reference when the referenceType
is EMAIL
. Otherwise, null.
Information about a reference when the referenceType
is EMAIL
. Otherwise, null.
An empty value.
', 'refs' => [ 'FieldValueUnion$EmptyValue' => 'An empty value.
', ], ], 'EncryptionConfig' => [ 'base' => 'The encryption configuration.
', 'refs' => [ 'KinesisVideoStreamConfig$EncryptionConfig' => 'The encryption configuration.
', 'S3Config$EncryptionConfig' => 'The Amazon S3 encryption configuration.
', ], ], 'EncryptionType' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfig$EncryptionType' => 'The type of encryption.
', ], ], 'EndAssociatedTasksActionDefinition' => [ 'base' => 'End associated tasks related to a case.
', 'refs' => [ 'RuleAction$EndAssociatedTasksAction' => 'Information about the end associated tasks action.
Supported only for TriggerEventSource
values: OnCaseUpdate
.
Information about the endpoint.
', 'refs' => [ 'ContactDataRequest$SystemEndpoint' => 'Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.
', 'ContactDataRequest$CustomerEndpoint' => 'Endpoint of the customer for which contact will be initiated.
', ], ], 'EndpointAddress' => [ 'base' => NULL, 'refs' => [ 'Endpoint$Address' => 'Address of the endpoint.
', ], ], 'EndpointType' => [ 'base' => NULL, 'refs' => [ 'Endpoint$Type' => 'Type of the endpoint.
', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'AttachedFileError$ErrorCode' => 'Status code describing the failure.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AttachedFileError$ErrorMessage' => 'Why the attached file couldn\'t be retrieved.
', ], ], 'ErrorResult' => [ 'base' => 'This API is in preview release for Amazon Connect and is subject to change.
List of errors for dataset association failures.
', 'refs' => [ 'ErrorResults$member' => NULL, ], ], 'ErrorResults' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateAnalyticsDataSetResponse$Errors' => 'A list of errors for datasets that aren\'t successfully associated with the target account.
', 'BatchDisassociateAnalyticsDataSetResponse$Errors' => 'A list of errors for any datasets not successfully removed.
', ], ], 'Evaluation' => [ 'base' => 'Information about a contact evaluation.
', 'refs' => [ 'DescribeContactEvaluationResponse$Evaluation' => 'Information about the evaluation form completed for a specific contact.
', ], ], 'EvaluationAnswerData' => [ 'base' => 'Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
', 'refs' => [ 'EvaluationAnswerInput$Value' => 'The value for an answer in a contact evaluation.
', 'EvaluationAnswerOutput$Value' => 'The value for an answer in a contact evaluation.
', 'EvaluationAnswerOutput$SystemSuggestedValue' => 'The system suggested value for an answer in a contact evaluation.
', ], ], 'EvaluationAnswerDataNumericValue' => [ 'base' => NULL, 'refs' => [ 'EvaluationAnswerData$NumericValue' => 'The numeric value for an answer in a contact evaluation.
', ], ], 'EvaluationAnswerDataStringValue' => [ 'base' => NULL, 'refs' => [ 'EvaluationAnswerData$StringValue' => 'The string value for an answer in a contact evaluation.
', ], ], 'EvaluationAnswerInput' => [ 'base' => 'Information about input answers for a contact evaluation.
', 'refs' => [ 'EvaluationAnswersInputMap$value' => NULL, ], ], 'EvaluationAnswerOutput' => [ 'base' => 'Information about output answers for a contact evaluation.
', 'refs' => [ 'EvaluationAnswersOutputMap$value' => NULL, ], ], 'EvaluationAnswersInputMap' => [ 'base' => NULL, 'refs' => [ 'SubmitContactEvaluationRequest$Answers' => 'A map of question identifiers to answer value.
', 'UpdateContactEvaluationRequest$Answers' => 'A map of question identifiers to answer value.
', ], ], 'EvaluationAnswersOutputMap' => [ 'base' => NULL, 'refs' => [ 'Evaluation$Answers' => 'A map of question identifiers to answer value.
', ], ], 'EvaluationForm' => [ 'base' => 'Information about the evaluation form.
', 'refs' => [ 'DescribeEvaluationFormResponse$EvaluationForm' => 'Information about the evaluation form.
', ], ], 'EvaluationFormContent' => [ 'base' => 'Information about an evaluation form used in a contact evaluation.
', 'refs' => [ 'DescribeContactEvaluationResponse$EvaluationForm' => 'Information about the evaluation form.
', ], ], 'EvaluationFormDescription' => [ 'base' => NULL, 'refs' => [ 'CreateEvaluationFormRequest$Description' => 'The description of the evaluation form.
', 'EvaluationForm$Description' => 'The description of the evaluation form.
', 'EvaluationFormContent$Description' => 'The description of the evaluation form.
', 'UpdateEvaluationFormRequest$Description' => 'The description of the evaluation form.
', ], ], 'EvaluationFormId' => [ 'base' => NULL, 'refs' => [ 'SubmitAutoEvaluationActionDefinition$EvaluationFormId' => 'The identifier of the auto-evaluation enabled form.
', ], ], 'EvaluationFormItem' => [ 'base' => 'Information about an item from an evaluation form. The item must be either a section or a question.
', 'refs' => [ 'EvaluationFormItemsList$member' => NULL, ], ], 'EvaluationFormItemWeight' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$Weight' => 'The scoring weight of the section.
', 'EvaluationFormSection$Weight' => 'The scoring weight of the section.
', ], ], 'EvaluationFormItemsList' => [ 'base' => NULL, 'refs' => [ 'CreateEvaluationFormRequest$Items' => 'Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
', 'EvaluationForm$Items' => 'Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
', 'EvaluationFormContent$Items' => 'Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
', 'EvaluationFormSection$Items' => 'The items of the section.
', 'UpdateEvaluationFormRequest$Items' => 'Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
', ], ], 'EvaluationFormNumericQuestionAutomation' => [ 'base' => 'Information about the automation configuration in numeric questions.
', 'refs' => [ 'EvaluationFormNumericQuestionProperties$Automation' => 'The automation properties of the numeric question.
', ], ], 'EvaluationFormNumericQuestionOption' => [ 'base' => 'Information about the option range used for scoring in numeric questions.
', 'refs' => [ 'EvaluationFormNumericQuestionOptionList$member' => NULL, ], ], 'EvaluationFormNumericQuestionOptionList' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormNumericQuestionProperties$Options' => 'The scoring options of the numeric question.
', ], ], 'EvaluationFormNumericQuestionProperties' => [ 'base' => 'Information about properties for a numeric question in an evaluation form.
', 'refs' => [ 'EvaluationFormQuestionTypeProperties$Numeric' => 'The properties of the numeric question.
', ], ], 'EvaluationFormQuestion' => [ 'base' => 'Information about a question from an evaluation form.
', 'refs' => [ 'EvaluationFormItem$Question' => 'The information of the question.
', ], ], 'EvaluationFormQuestionAnswerScore' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormNumericQuestionOption$Score' => 'The score assigned to answer values within the range option.
', 'EvaluationFormSingleSelectQuestionOption$Score' => 'The score assigned to the answer option.
', ], ], 'EvaluationFormQuestionInstructions' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$Instructions' => 'The instructions of the section.
', 'EvaluationFormSection$Instructions' => 'The instructions of the section.
', ], ], 'EvaluationFormQuestionTitle' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$Title' => 'The title of the question.
', ], ], 'EvaluationFormQuestionType' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$QuestionType' => 'The type of the question.
', ], ], 'EvaluationFormQuestionTypeProperties' => [ 'base' => 'Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.
', 'refs' => [ 'EvaluationFormQuestion$QuestionTypeProperties' => 'The properties of the type of question. Text questions do not have to define question type properties.
', ], ], 'EvaluationFormScoringMode' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormScoringStrategy$Mode' => 'The scoring mode of the evaluation form.
', ], ], 'EvaluationFormScoringStatus' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormScoringStrategy$Status' => 'The scoring status of the evaluation form.
', ], ], 'EvaluationFormScoringStrategy' => [ 'base' => 'Information about scoring strategy for an evaluation form.
', 'refs' => [ 'CreateEvaluationFormRequest$ScoringStrategy' => 'A scoring strategy of the evaluation form.
', 'EvaluationForm$ScoringStrategy' => 'A scoring strategy of the evaluation form.
', 'EvaluationFormContent$ScoringStrategy' => 'A scoring strategy of the evaluation form.
', 'UpdateEvaluationFormRequest$ScoringStrategy' => 'A scoring strategy of the evaluation form.
', ], ], 'EvaluationFormSection' => [ 'base' => 'Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).
', 'refs' => [ 'EvaluationFormItem$Section' => 'The information of the section.
', ], ], 'EvaluationFormSectionTitle' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSection$Title' => 'The title of the section.
', ], ], 'EvaluationFormSingleSelectQuestionAutomation' => [ 'base' => 'Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.
', 'refs' => [ 'EvaluationFormSingleSelectQuestionProperties$Automation' => 'The display mode of the single select question.
', ], ], 'EvaluationFormSingleSelectQuestionAutomationOption' => [ 'base' => 'Information about the automation option of a single select question.
', 'refs' => [ 'EvaluationFormSingleSelectQuestionAutomationOptionList$member' => NULL, ], ], 'EvaluationFormSingleSelectQuestionAutomationOptionList' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSingleSelectQuestionAutomation$Options' => 'The automation options of the single select question.
', ], ], 'EvaluationFormSingleSelectQuestionDisplayMode' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSingleSelectQuestionProperties$DisplayAs' => 'The display mode of the single select question.
', ], ], 'EvaluationFormSingleSelectQuestionOption' => [ 'base' => 'Information about the automation configuration in single select questions.
', 'refs' => [ 'EvaluationFormSingleSelectQuestionOptionList$member' => NULL, ], ], 'EvaluationFormSingleSelectQuestionOptionList' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSingleSelectQuestionProperties$Options' => 'The answer options of the single select question.
', ], ], 'EvaluationFormSingleSelectQuestionOptionText' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSingleSelectQuestionOption$Text' => 'The title of the answer option.
', ], ], 'EvaluationFormSingleSelectQuestionProperties' => [ 'base' => 'Information about the options in single select questions.
', 'refs' => [ 'EvaluationFormQuestionTypeProperties$SingleSelect' => 'The properties of the numeric question.
', ], ], 'EvaluationFormSummary' => [ 'base' => 'Summary information about an evaluation form.
', 'refs' => [ 'EvaluationFormSummaryList$member' => NULL, ], ], 'EvaluationFormSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEvaluationFormsResponse$EvaluationFormSummaryList' => 'Provides details about a list of evaluation forms belonging to an instance.
', ], ], 'EvaluationFormTitle' => [ 'base' => NULL, 'refs' => [ 'CreateEvaluationFormRequest$Title' => 'A title of the evaluation form.
', 'EvaluationForm$Title' => 'A title of the evaluation form.
', 'EvaluationFormContent$Title' => 'A title of the evaluation form.
', 'EvaluationFormSummary$Title' => 'A title of the evaluation form.
', 'EvaluationSummary$EvaluationFormTitle' => 'A title of the evaluation form.
', 'UpdateEvaluationFormRequest$Title' => 'A title of the evaluation form.
', ], ], 'EvaluationFormVersionIsLocked' => [ 'base' => NULL, 'refs' => [ 'EvaluationForm$Locked' => 'The flag indicating whether the evaluation form is locked for changes.
', 'EvaluationFormVersionSummary$Locked' => 'The flag indicating whether the evaluation form is locked for changes.
', ], ], 'EvaluationFormVersionStatus' => [ 'base' => NULL, 'refs' => [ 'EvaluationForm$Status' => 'The status of the evaluation form.
', 'EvaluationFormVersionSummary$Status' => 'The status of the evaluation form.
', ], ], 'EvaluationFormVersionSummary' => [ 'base' => 'Summary information about an evaluation form.
', 'refs' => [ 'EvaluationFormVersionSummaryList$member' => NULL, ], ], 'EvaluationFormVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEvaluationFormVersionsResponse$EvaluationFormVersionSummaryList' => 'Provides details about a list of evaluation forms belonging to an instance.
', ], ], 'EvaluationMetadata' => [ 'base' => 'Metadata information about a contact evaluation.
', 'refs' => [ 'Evaluation$Metadata' => 'Metadata about the contact evaluation.
', ], ], 'EvaluationNote' => [ 'base' => 'Information about notes for a contact evaluation.
', 'refs' => [ 'EvaluationNotesMap$value' => NULL, ], ], 'EvaluationNoteString' => [ 'base' => NULL, 'refs' => [ 'EvaluationNote$Value' => 'The note for an item (section or question) in a contact evaluation.
Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.
A map of question identifiers to note value.
', 'SubmitContactEvaluationRequest$Notes' => 'A map of question identifiers to note value.
', 'UpdateContactEvaluationRequest$Notes' => 'A map of question identifiers to note value.
', ], ], 'EvaluationScore' => [ 'base' => 'Information about scores of a contact evaluation item (section or question).
', 'refs' => [ 'EvaluationMetadata$Score' => 'The overall score of the contact evaluation.
', 'EvaluationScoresMap$value' => NULL, 'EvaluationSummary$Score' => 'The overall score of the contact evaluation.
', ], ], 'EvaluationScorePercentage' => [ 'base' => NULL, 'refs' => [ 'EvaluationScore$Percentage' => 'The score percentage for an item in a contact evaluation.
', ], ], 'EvaluationScoresMap' => [ 'base' => NULL, 'refs' => [ 'Evaluation$Scores' => 'A map of item (section or question) identifiers to score value.
', ], ], 'EvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'Evaluation$Status' => 'The status of the contact evaluation.
', 'EvaluationSummary$Status' => 'The status of the contact evaluation.
', ], ], 'EvaluationSummary' => [ 'base' => 'Summary information about a contact evaluation.
', 'refs' => [ 'EvaluationSummaryList$member' => NULL, ], ], 'EvaluationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListContactEvaluationsResponse$EvaluationSummaryList' => 'Provides details about a list of contact evaluations belonging to an instance.
', ], ], 'EventBridgeActionDefinition' => [ 'base' => 'The EventBridge action definition.
', 'refs' => [ 'RuleAction$EventBridgeAction' => 'Information about the EventBridge action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
The name.
', ], ], 'EventSourceName' => [ 'base' => NULL, 'refs' => [ 'ListRulesRequest$EventSourceName' => 'The name of the event source.
', 'RuleSummary$EventSourceName' => 'The name of the event source.
', 'RuleTriggerEventSource$EventSourceName' => 'The name of the event source.
', ], ], 'Expiry' => [ 'base' => 'An object to specify the expiration of a routing step.
', 'refs' => [ 'Step$Expiry' => 'An object to specify the expiration of a routing step.
', ], ], 'Expression' => [ 'base' => 'A tagged union to specify expression for a routing step.
', 'refs' => [ 'Expressions$member' => NULL, 'Step$Expression' => 'A tagged union to specify expression for a routing step.
', ], ], 'Expressions' => [ 'base' => NULL, 'refs' => [ 'Expression$AndExpression' => 'List of routing expressions which will be AND-ed together.
', 'Expression$OrExpression' => 'List of routing expressions which will be OR-ed together.
', ], ], 'FailedRequest' => [ 'base' => 'Request for which contact failed to be generated.
', 'refs' => [ 'FailedRequestList$member' => NULL, ], ], 'FailedRequestList' => [ 'base' => NULL, 'refs' => [ 'BatchPutContactResponse$FailedRequestList' => 'List of requests for which contact creation failed.
', ], ], 'FailureReasonCode' => [ 'base' => NULL, 'refs' => [ 'FailedRequest$FailureReasonCode' => 'Reason code for the failure.
', ], ], 'FieldStringValue' => [ 'base' => NULL, 'refs' => [ 'FieldValueUnion$StringValue' => 'String value type.
', ], ], 'FieldValue' => [ 'base' => 'Object for case field values.
', 'refs' => [ 'FieldValues$member' => NULL, ], ], 'FieldValueId' => [ 'base' => NULL, 'refs' => [ 'FieldValue$Id' => 'Unique identifier of a field.
', ], ], 'FieldValueUnion' => [ 'base' => 'Object to store union of Field values.
', 'refs' => [ 'FieldValue$Value' => 'Union of potential field value types.
', ], ], 'FieldValues' => [ 'base' => NULL, 'refs' => [ 'CreateCaseActionDefinition$Fields' => 'An array of objects with Field ID
and Value
data.
An array of objects with Field ID
and Value data.
The unique identifier of the attached file resource.
', 'AttachedFileError$FileId' => 'The unique identifier of the attached file resource.
', 'CompleteAttachedFileUploadRequest$FileId' => 'The unique identifier of the attached file resource.
', 'DeleteAttachedFileRequest$FileId' => 'The unique identifier of the attached file resource.
', 'FileIdList$member' => NULL, 'GetAttachedFileRequest$FileId' => 'The unique identifier of the attached file resource.
', 'GetAttachedFileResponse$FileId' => 'The unique identifier of the attached file resource.
', 'StartAttachedFileUploadResponse$FileId' => 'The unique identifier of the attached file resource.
', ], ], 'FileIdList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAttachedFileMetadataRequest$FileIds' => 'The unique identifiers of the attached file resource.
', ], ], 'FileName' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$FileName' => 'A case-sensitive name of the attached file being uploaded.
', 'GetAttachedFileResponse$FileName' => 'A case-sensitive name of the attached file being uploaded.
', 'StartAttachedFileUploadRequest$FileName' => 'A case-sensitive name of the attached file being uploaded.
', ], ], 'FileSizeInBytes' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$FileSizeInBytes' => 'The size of the attached file in bytes.
', 'GetAttachedFileResponse$FileSizeInBytes' => 'The size of the attached file in bytes.
', 'StartAttachedFileUploadRequest$FileSizeInBytes' => 'The size of the attached file in bytes.
', ], ], 'FileStatusType' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$FileStatus' => 'The current status of the attached file.
', 'GetAttachedFileResponse$FileStatus' => 'The current status of the attached file.
', 'StartAttachedFileUploadResponse$FileStatus' => 'The current status of the attached file.
', ], ], 'FileUseCaseType' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$FileUseCaseType' => 'The use case for the file.
', 'GetAttachedFileResponse$FileUseCaseType' => 'The use case for the file.
', 'StartAttachedFileUploadRequest$FileUseCaseType' => 'The use case for the file.
', ], ], 'FilterV2' => [ 'base' => 'Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
', 'refs' => [ 'FiltersV2List$member' => NULL, ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'FilterV2$FilterValues' => 'The identifiers to use for filtering data. For example, if you have a filter key of QUEUE
, you would add queue IDs or ARNs in FilterValues
.
Contains the filter to apply when retrieving metrics.
', 'refs' => [ 'GetCurrentMetricDataRequest$Filters' => 'The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
RoutingStepExpressions: 50
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
When using the RoutingStepExpression
filter, you need to pass exactly one QueueId
. The filter is also case sensitive so when using the RoutingStepExpression
filter, grouping by ROUTING_STEP_EXPRESSION
is required.
Currently tagging is only supported on the resources that are passed in the filter.
', 'GetMetricDataRequest$Filters' => 'The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
The filters to apply to returned metrics. You can filter on the following resources:
Agents
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT
| AGENT_HIERARCHY_LEVEL_ONE
| AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
| CASE_TEMPLATE_ARN
| CASE_STATUS
| CHANNEL
| contact/segmentAttributes/connect:Subtype
| FEATURE
| FLOW_TYPE
| FLOWS_NEXT_RESOURCE_ID
| FLOWS_NEXT_RESOURCE_QUEUE_ID
| FLOWS_OUTCOME_TYPE
| FLOWS_RESOURCE_ID
| INITIATION_METHOD
| RESOURCE_PUBLISHED_TIMESTAMP
| ROUTING_PROFILE
| ROUTING_STEP_EXPRESSION
| QUEUE
| Q_CONNECT_ENABLED
|
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics
is a valid filterValue for the FEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat
, connect:SMS
, connect:Telephony
, and connect:WebRTC
are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter
key.
ROUTING_STEP_EXPRESSION
is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
Q_CONNECT_ENABLED
. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED
filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
A valid resource type.
', 'DisassociateFlowRequest$ResourceType' => 'A valid resource type.
', 'GetFlowAssociationRequest$ResourceType' => 'A valid resource type.
', 'GetFlowAssociationResponse$ResourceType' => 'A valid resource type.
', ], ], 'FlowAssociationSummary' => [ 'base' => 'Information about flow associations.
', 'refs' => [ 'FlowAssociationSummaryList$member' => NULL, ], ], 'FlowAssociationSummaryList' => [ 'base' => NULL, 'refs' => [ 'BatchGetFlowAssociationResponse$FlowAssociationSummaryList' => 'Information about flow associations.
', 'ListFlowAssociationsResponse$FlowAssociationSummaryList' => 'Summary of flow associations.
', ], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'AssociateLambdaFunctionRequest$FunctionArn' => 'The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
', 'DisassociateLambdaFunctionRequest$FunctionArn' => 'The Amazon Resource Name (ARN) of the Lambda function being disassociated.
', 'FunctionArnsList$member' => NULL, ], ], 'FunctionArnsList' => [ 'base' => NULL, 'refs' => [ 'ListLambdaFunctionsResponse$LambdaFunctions' => 'The Lambdafunction ARNs associated with the specified instance.
', ], ], 'GetAttachedFileRequest' => [ 'base' => 'Request to GetAttachedFile API.', 'refs' => [], ], 'GetAttachedFileResponse' => [ 'base' => 'Response from GetAttachedFile API.', 'refs' => [], ], 'GetContactAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContactAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCurrentMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCurrentMetricDataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCurrentUserDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCurrentUserDataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFederationTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFederationTokenResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFlowAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFlowAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMetricDataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMetricDataV2Request' => [ 'base' => NULL, 'refs' => [], ], 'GetMetricDataV2Response' => [ 'base' => NULL, 'refs' => [], ], 'GetPromptFileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPromptFileResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTaskTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTaskTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTrafficDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTrafficDistributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Grouping' => [ 'base' => NULL, 'refs' => [ 'Groupings$member' => NULL, ], ], 'GroupingV2' => [ 'base' => NULL, 'refs' => [ 'GroupingsV2$member' => NULL, ], ], 'Groupings' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataRequest$Groupings' => 'The grouping applied to the metrics returned. For example, when grouped by QUEUE
, the metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by ROUTING_PROFILE
, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED
, CONTACTS_IN_QUEUE
, and OLDEST_CONTACT_AGE
.
If no Grouping
is included in the request, a summary of metrics is returned.
When using the RoutingStepExpression
filter, group by ROUTING_STEP_EXPRESSION
is required.
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
', ], ], 'GroupingsV2' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataV2Request$Groupings' => 'The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT
| AGENT_HIERARCHY_LEVEL_ONE
| AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
| CASE_TEMPLATE_ARN
| CASE_STATUS
| CHANNEL
| contact/segmentAttributes/connect:Subtype
| FLOWS_RESOURCE_ID
| FLOWS_MODULE_RESOURCE_ID
| FLOW_TYPE
| FLOWS_OUTCOME_TYPE
| INITIATION_METHOD
| Q_CONNECT_ENABLED
| QUEUE
| RESOURCE_PUBLISHED_TIMESTAMP
| ROUTING_PROFILE
| ROUTING_STEP_EXPRESSION
Contains information about a hierarchy group.
', 'refs' => [ 'DescribeUserHierarchyGroupResponse$HierarchyGroup' => 'Information about the hierarchy group.
', ], ], 'HierarchyGroupCondition' => [ 'base' => 'A leaf node condition which can be used to specify a hierarchy group condition.
', 'refs' => [ 'AttributeAndCondition$HierarchyGroupCondition' => NULL, 'ControlPlaneUserAttributeFilter$HierarchyGroupCondition' => NULL, 'UserSearchCriteria$HierarchyGroupCondition' => 'A leaf node condition which can be used to specify a hierarchy group condition.
', ], ], 'HierarchyGroupId' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$AllowedAccessControlHierarchyGroupId' => 'The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
', 'CreateUserHierarchyGroupRequest$ParentGroupId' => 'The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
', 'CreateUserHierarchyGroupResponse$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'CreateUserRequest$HierarchyGroupId' => 'The identifier of the hierarchy group for the user.
', 'DeleteUserHierarchyGroupRequest$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'DescribeUserHierarchyGroupRequest$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'HierarchyGroup$Id' => 'The identifier of the hierarchy group.
', 'HierarchyGroupIdList$member' => NULL, 'HierarchyGroupSummary$Id' => 'The identifier of the hierarchy group.
', 'HierarchyGroupSummaryReference$Id' => 'The unique identifier for the hierarchy group.
', 'SecurityProfile$AllowedAccessControlHierarchyGroupId' => 'The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
', 'UpdateSecurityProfileRequest$AllowedAccessControlHierarchyGroupId' => 'The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
', 'UpdateUserHierarchyGroupNameRequest$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'UpdateUserHierarchyRequest$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'User$HierarchyGroupId' => 'The identifier of the hierarchy group for the user.
', 'UserDataHierarchyGroups$member' => NULL, 'UserSearchSummary$HierarchyGroupId' => 'The identifier of the user\'s hierarchy group.
', ], ], 'HierarchyGroupIdList' => [ 'base' => NULL, 'refs' => [ 'AgentHierarchyGroups$L1Ids' => 'The identifiers for level 1 hierarchy groups.
', 'AgentHierarchyGroups$L2Ids' => 'The identifiers for level 2 hierarchy groups.
', 'AgentHierarchyGroups$L3Ids' => 'The identifiers for level 3 hierarchy groups.
', 'AgentHierarchyGroups$L4Ids' => 'The identifiers for level 4 hierarchy groups.
', 'AgentHierarchyGroups$L5Ids' => 'The identifiers for level 5 hierarchy groups.
', ], ], 'HierarchyGroupMatchType' => [ 'base' => NULL, 'refs' => [ 'HierarchyGroupCondition$HierarchyGroupMatchType' => 'The type of hierarchy group match.
', ], ], 'HierarchyGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateUserHierarchyGroupRequest$Name' => 'The name of the user hierarchy group. Must not be more than 100 characters.
', 'HierarchyGroup$Name' => 'The name of the hierarchy group.
', 'HierarchyGroupSummary$Name' => 'The name of the hierarchy group.
', 'UpdateUserHierarchyGroupNameRequest$Name' => 'The name of the hierarchy group. Must not be more than 100 characters.
', ], ], 'HierarchyGroupSummary' => [ 'base' => 'Contains summary information about a hierarchy group.
', 'refs' => [ 'HierarchyGroupSummaryList$member' => NULL, 'HierarchyPath$LevelOne' => 'Information about level one.
', 'HierarchyPath$LevelTwo' => 'Information about level two.
', 'HierarchyPath$LevelThree' => 'Information about level three.
', 'HierarchyPath$LevelFour' => 'Information about level four.
', 'HierarchyPath$LevelFive' => 'Information about level five.
', ], ], 'HierarchyGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListUserHierarchyGroupsResponse$UserHierarchyGroupSummaryList' => 'Information about the hierarchy groups.
', ], ], 'HierarchyGroupSummaryReference' => [ 'base' => 'Information about the hierarchy group.
', 'refs' => [ 'HierarchyPathReference$LevelOne' => 'Information about level one.
', 'HierarchyPathReference$LevelTwo' => 'Information about level two.
', 'HierarchyPathReference$LevelThree' => 'Information about level three.
', 'HierarchyPathReference$LevelFour' => 'Information about level four.
', 'HierarchyPathReference$LevelFive' => 'Information about level five.
', ], ], 'HierarchyGroups' => [ 'base' => 'Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
', 'refs' => [ 'AgentInfo$HierarchyGroups' => 'The agent hierarchy groups for the agent.
', ], ], 'HierarchyLevel' => [ 'base' => 'Contains information about a hierarchy level.
', 'refs' => [ 'HierarchyStructure$LevelOne' => 'Information about level one.
', 'HierarchyStructure$LevelTwo' => 'Information about level two.
', 'HierarchyStructure$LevelThree' => 'Information about level three.
', 'HierarchyStructure$LevelFour' => 'Information about level four.
', 'HierarchyStructure$LevelFive' => 'Information about level five.
', ], ], 'HierarchyLevelId' => [ 'base' => NULL, 'refs' => [ 'HierarchyGroup$LevelId' => 'The identifier of the level in the hierarchy group.
', 'HierarchyLevel$Id' => 'The identifier of the hierarchy level.
', ], ], 'HierarchyLevelName' => [ 'base' => NULL, 'refs' => [ 'HierarchyLevel$Name' => 'The name of the hierarchy level.
', 'HierarchyLevelUpdate$Name' => 'The name of the user hierarchy level. Must not be more than 50 characters.
', ], ], 'HierarchyLevelUpdate' => [ 'base' => 'Contains information about the hierarchy level to update.
', 'refs' => [ 'HierarchyStructureUpdate$LevelOne' => 'The update for level one.
', 'HierarchyStructureUpdate$LevelTwo' => 'The update for level two.
', 'HierarchyStructureUpdate$LevelThree' => 'The update for level three.
', 'HierarchyStructureUpdate$LevelFour' => 'The update for level four.
', 'HierarchyStructureUpdate$LevelFive' => 'The update for level five.
', ], ], 'HierarchyPath' => [ 'base' => 'Contains information about the levels of a hierarchy group.
', 'refs' => [ 'HierarchyGroup$HierarchyPath' => 'Information about the levels in the hierarchy group.
', ], ], 'HierarchyPathReference' => [ 'base' => 'Information about the levels in the hierarchy group.
', 'refs' => [ 'UserData$HierarchyPath' => 'Contains information about the levels of a hierarchy group assigned to a user.
', ], ], 'HierarchyRestrictedResourceList' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$HierarchyRestrictedResources' => 'The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
.
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
.
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
.
Contains information about a hierarchy structure.
', 'refs' => [ 'DescribeUserHierarchyStructureResponse$HierarchyStructure' => 'Information about the hierarchy structure.
', ], ], 'HierarchyStructureUpdate' => [ 'base' => 'Contains information about the level hierarchy to update.
', 'refs' => [ 'UpdateUserHierarchyStructureRequest$HierarchyStructure' => 'The hierarchy levels to update.
', ], ], 'HistoricalMetric' => [ 'base' => 'Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
', 'refs' => [ 'HistoricalMetricData$Metric' => 'Information about the metric.
', 'HistoricalMetrics$member' => NULL, ], ], 'HistoricalMetricData' => [ 'base' => 'Contains the data for a historical metric.
', 'refs' => [ 'HistoricalMetricDataCollections$member' => NULL, ], ], 'HistoricalMetricDataCollections' => [ 'base' => NULL, 'refs' => [ 'HistoricalMetricResult$Collections' => 'The set of metrics.
', ], ], 'HistoricalMetricName' => [ 'base' => 'The historical metric names.
', 'refs' => [ 'HistoricalMetric$Name' => 'The name of the metric.
', ], ], 'HistoricalMetricResult' => [ 'base' => 'Contains information about the historical metrics retrieved.
', 'refs' => [ 'HistoricalMetricResults$member' => NULL, ], ], 'HistoricalMetricResults' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataResponse$MetricResults' => 'Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
', ], ], 'HistoricalMetrics' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataRequest$HistoricalMetrics' => 'The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there\'s no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
', ], ], 'Hours24Format' => [ 'base' => NULL, 'refs' => [ 'HoursOfOperationTimeSlice$Hours' => 'The hours.
', ], ], 'HoursOfOperation' => [ 'base' => 'Information about of the hours of operation.
', 'refs' => [ 'DescribeHoursOfOperationResponse$HoursOfOperation' => 'The hours of operation.
', 'HoursOfOperationList$member' => NULL, ], ], 'HoursOfOperationConfig' => [ 'base' => 'Contains information about the hours of operation.
', 'refs' => [ 'HoursOfOperationConfigList$member' => NULL, ], ], 'HoursOfOperationConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationRequest$Config' => 'Configuration information for the hours of operation: day, start time, and end time.
', 'HoursOfOperation$Config' => 'Configuration information for the hours of operation.
', 'UpdateHoursOfOperationRequest$Config' => 'Configuration information of the hours of operation.
', ], ], 'HoursOfOperationDays' => [ 'base' => NULL, 'refs' => [ 'HoursOfOperationConfig$Day' => 'The day that the hours of operation applies to.
', ], ], 'HoursOfOperationDescription' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationRequest$Description' => 'The description of the hours of operation.
', 'HoursOfOperation$Description' => 'The description for the hours of operation.
', ], ], 'HoursOfOperationId' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationResponse$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'CreateQueueRequest$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'DeleteHoursOfOperationRequest$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'DescribeHoursOfOperationRequest$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'HoursOfOperation$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'HoursOfOperationSummary$Id' => 'The identifier of the hours of operation.
', 'Queue$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'UpdateHoursOfOperationRequest$HoursOfOperationId' => 'The identifier of the hours of operation.
', 'UpdateQueueHoursOfOperationRequest$HoursOfOperationId' => 'The identifier for the hours of operation.
', ], ], 'HoursOfOperationList' => [ 'base' => NULL, 'refs' => [ 'SearchHoursOfOperationsResponse$HoursOfOperations' => 'Information about the hours of operations.
', ], ], 'HoursOfOperationName' => [ 'base' => NULL, 'refs' => [ 'HoursOfOperationSummary$Name' => 'The name of the hours of operation.
', ], ], 'HoursOfOperationSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'HoursOfOperationSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'HoursOfOperationSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'HoursOfOperationSearchCriteria' => [ 'base' => 'The search criteria to be used to return hours of operations.
', 'refs' => [ 'HoursOfOperationSearchConditionList$member' => NULL, 'SearchHoursOfOperationsRequest$SearchCriteria' => 'The search criteria to be used to return hours of operations.
', ], ], 'HoursOfOperationSearchFilter' => [ 'base' => 'Filters to be applied to search results.
', 'refs' => [ 'SearchHoursOfOperationsRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'HoursOfOperationSummary' => [ 'base' => 'Contains summary information about hours of operation for a contact center.
', 'refs' => [ 'HoursOfOperationSummaryList$member' => NULL, ], ], 'HoursOfOperationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListHoursOfOperationsResponse$HoursOfOperationSummaryList' => 'Information about the hours of operation.
', ], ], 'HoursOfOperationTimeSlice' => [ 'base' => 'The start time or end time for an hours of operation.
', 'refs' => [ 'HoursOfOperationConfig$StartTime' => 'The start time that your contact center opens.
', 'HoursOfOperationConfig$EndTime' => 'The end time that your contact center closes.
', ], ], 'ISO8601Datetime' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$CreationTime' => 'The time of Creation of the file resource as an ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example, 2024-05-03T02:41:28.172Z
.
The expiration time of the URL in ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
', 'GetAttachedFileResponse$CreationTime' => 'The time of Creation of the file resource as an ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example, 2024-05-03T02:41:28.172Z
.
The expiration of the token. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
', 'StartAttachedFileUploadResponse$CreationTime' => 'The time of Creation of the file resource as an ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example, 2024-05-03T02:41:28.172Z
.
The expiration time of the URL in ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example, 2019-11-08T02:41:28.172Z
.
An entity with the same name already exists.
', 'refs' => [], ], 'ImportPhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportPhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'InboundCallsEnabled' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceRequest$InboundCallsEnabled' => 'Your contact center handles incoming contacts.
', 'Instance$InboundCallsEnabled' => 'Whether inbound calls are enabled.
', 'InstanceSummary$InboundCallsEnabled' => 'Whether inbound calls are enabled.
', ], ], 'Index' => [ 'base' => NULL, 'refs' => [ 'RoutingCriteria$Index' => 'Information about the index of the routing criteria.
', ], ], 'InitiationMethodList' => [ 'base' => NULL, 'refs' => [ 'SearchCriteria$InitiationMethods' => 'The list of initiation methods associated with contacts.
', ], ], 'Instance' => [ 'base' => 'The Amazon Connect instance.
', 'refs' => [ 'DescribeInstanceResponse$Instance' => 'The name of the instance.
', ], ], 'InstanceArn' => [ 'base' => NULL, 'refs' => [ 'TrafficDistributionGroup$InstanceArn' => 'The Amazon Resource Name (ARN).
', 'TrafficDistributionGroupSummary$InstanceArn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', ], ], 'InstanceAttributeType' => [ 'base' => NULL, 'refs' => [ 'Attribute$AttributeType' => 'The type of attribute.
', 'DescribeInstanceAttributeRequest$AttributeType' => 'The type of attribute.
', 'UpdateInstanceAttributeRequest$AttributeType' => 'The type of attribute.
Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
The value of the attribute.
', 'UpdateInstanceAttributeRequest$Value' => 'The value for the attribute. Maximum character limit is 100.
', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'ActivateEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateAnalyticsDataSetRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateApprovedOriginRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateBotRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateDefaultVocabularyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateInstanceStorageConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateLambdaFunctionRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateLexBotRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociatePhoneNumberContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateQueueQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateRoutingProfileQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateSecurityKeyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateTrafficDistributionGroupUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateUserProficienciesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).
', 'BatchAssociateAnalyticsDataSetRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'BatchDisassociateAnalyticsDataSetRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'BatchGetAttachedFileMetadataRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'BatchGetFlowAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'BatchPutContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ClaimPhoneNumberRequest$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CompleteAttachedFileUploadRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'CreateAgentStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateContactFlowModuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'CreateEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateInstanceResponse$Id' => 'The identifier for the instance.
', 'CreateIntegrationAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateParticipantRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreatePersistentContactAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreatePredefinedAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreatePromptRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateQueueRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateQuickConnectRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateRoutingProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateRuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateSecurityProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateTaskTemplateRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateUseCaseRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateUserHierarchyGroupRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateVocabularyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeactivateEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DefaultVocabulary$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteAttachedFileRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'DeleteContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteContactFlowModuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteInstanceRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteIntegrationAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeletePredefinedAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeletePromptRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteQueueRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteQuickConnectRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteRoutingProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteRuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteSecurityProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteTaskTemplateRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteUseCaseRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteUserHierarchyGroupRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteVocabularyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeAgentStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeContactFlowModuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'DescribeContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeInstanceAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeInstanceRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeInstanceStorageConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribePredefinedAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribePromptRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeQueueRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeQuickConnectRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeRoutingProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeRuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeSecurityProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeUserHierarchyGroupRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeUserHierarchyStructureRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeVocabularyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateAnalyticsDataSetRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateApprovedOriginRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateBotRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateInstanceStorageConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateLambdaFunctionRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..
', 'DisassociateLexBotRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociatePhoneNumberContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateQueueQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateRoutingProfileQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateSecurityKeyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateTrafficDistributionGroupUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateUserProficienciesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DismissUserContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'GetAttachedFileRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'GetContactAttributesRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'GetCurrentMetricDataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetCurrentUserDataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetFederationTokenRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetFlowAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetMetricDataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetPromptFileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetTaskTemplateRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetTaskTemplateResponse$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ImportPhoneNumberRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'Instance$Id' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'InstanceSummary$Id' => 'The identifier of the instance.
', 'IntegrationAssociationSummary$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListAgentStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListAnalyticsDataAssociationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListApprovedOriginsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListBotsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListContactEvaluationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListContactFlowModulesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListContactFlowsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListContactReferencesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListDefaultVocabulariesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListEvaluationFormVersionsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListEvaluationFormsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListFlowAssociationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListHoursOfOperationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListInstanceAttributesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListInstanceStorageConfigsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListIntegrationAssociationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListLambdaFunctionsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListLexBotsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListPhoneNumbersRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListPhoneNumbersSummary$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListPhoneNumbersV2Request$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. If both TargetArn
and InstanceId
are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListPromptsRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'ListQueueQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListRealtimeContactAnalysisSegmentsV2Request$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListRoutingProfileQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListRoutingProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListRulesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListSecurityKeysRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListSecurityProfileApplicationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListSecurityProfilePermissionsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListSecurityProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListTaskTemplatesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListUseCasesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListUserHierarchyGroupsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListUserProficienciesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListUsersRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'MonitorContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'PauseContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ReplicateInstanceResponse$Id' => 'The identifier of the replicated instance. You can find the instanceId
in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ResumeContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchAvailablePhoneNumbersRequest$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchContactFlowsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchContactsRequest$InstanceId' => 'The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchHoursOfOperationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchPredefinedAttributesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchPromptsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchRoutingProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchSecurityProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchUsersRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
InstanceID is a required field. The "Required: No" below is incorrect.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SecurityProfile$OrganizationResourceId' => 'The organization resource identifier for the security profile.
', 'SecurityProfileSearchSummary$OrganizationResourceId' => 'The organization resource identifier.
', 'StartAttachedFileUploadRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'StartChatContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartContactRecordingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartContactStreamingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartOutboundVoiceContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartTaskContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartWebRTCContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StopContactRecordingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StopContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StopContactStreamingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SubmitContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SuspendContactRecordingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'TagContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'TransferContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UntagContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateAgentStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactAttributesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactFlowContentRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'UpdateContactFlowMetadataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactFlowModuleContentRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactFlowModuleMetadataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactFlowNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'UpdateContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactRoutingDataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactScheduleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateInstanceAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateInstanceStorageConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateParticipantRoleConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdatePhoneNumberRequest$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdatePromptRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueMaxContactsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueOutboundCallerConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQuickConnectConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQuickConnectNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileAgentAvailabilityTimerRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileConcurrencyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileDefaultOutboundQueueRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateSecurityProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateTaskTemplateRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateTaskTemplateResponse$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserHierarchyGroupNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserHierarchyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserHierarchyStructureRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserIdentityInfoRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserPhoneConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserProficienciesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserRoutingProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserSecurityProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', ], ], 'InstanceIdOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupRequest$InstanceId' => 'The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId
in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ReplicateInstanceRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId
, or the entire ARN.
The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.
', ], ], 'InstanceStatus' => [ 'base' => NULL, 'refs' => [ 'Instance$InstanceStatus' => 'The state of the instance.
', 'InstanceSummary$InstanceStatus' => 'The state of the instance.
', ], ], 'InstanceStatusReason' => [ 'base' => 'Relevant details why the instance was not successfully created.
', 'refs' => [ 'Instance$StatusReason' => 'Relevant details why the instance was not successfully created.
', ], ], 'InstanceStorageConfig' => [ 'base' => 'The storage configuration for the instance.
', 'refs' => [ 'AssociateInstanceStorageConfigRequest$StorageConfig' => 'A valid storage type.
', 'DescribeInstanceStorageConfigResponse$StorageConfig' => 'A valid storage type.
', 'InstanceStorageConfigs$member' => NULL, 'UpdateInstanceStorageConfigRequest$StorageConfig' => NULL, ], ], 'InstanceStorageConfigs' => [ 'base' => NULL, 'refs' => [ 'ListInstanceStorageConfigsResponse$StorageConfigs' => 'A valid storage type.
', ], ], 'InstanceStorageResourceType' => [ 'base' => NULL, 'refs' => [ 'AssociateInstanceStorageConfigRequest$ResourceType' => 'A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:
For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
.
For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
.
REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
for voice contacts moving forward.
If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
.
A valid resource type.
', 'DisassociateInstanceStorageConfigRequest$ResourceType' => 'A valid resource type.
', 'ListInstanceStorageConfigsRequest$ResourceType' => 'A valid resource type.
', 'UpdateInstanceStorageConfigRequest$ResourceType' => 'A valid resource type.
', ], ], 'InstanceSummary' => [ 'base' => 'Information about the instance.
', 'refs' => [ 'InstanceSummaryList$member' => NULL, ], ], 'InstanceSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesResponse$InstanceSummaryList' => 'Information about the instances.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormNumericQuestionOption$MinValue' => 'The minimum answer value of the range option.
', 'EvaluationFormNumericQuestionOption$MaxValue' => 'The maximum answer value of the range option.
', 'EvaluationFormNumericQuestionProperties$MinValue' => 'The minimum answer value.
', 'EvaluationFormNumericQuestionProperties$MaxValue' => 'The maximum answer value.
', ], ], 'IntegerCount' => [ 'base' => NULL, 'refs' => [ 'ChannelToCountMap$value' => NULL, ], ], 'IntegrationAssociationId' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationResponse$IntegrationAssociationId' => 'The identifier for the integration association.
', 'CreateUseCaseRequest$IntegrationAssociationId' => 'The identifier for the integration association.
', 'DeleteIntegrationAssociationRequest$IntegrationAssociationId' => 'The identifier for the integration association.
', 'DeleteUseCaseRequest$IntegrationAssociationId' => 'The identifier for the integration association.
', 'IntegrationAssociationSummary$IntegrationAssociationId' => 'The identifier for the AppIntegration association.
', 'ListUseCasesRequest$IntegrationAssociationId' => 'The identifier for the integration association.
', 'RuleTriggerEventSource$IntegrationAssociationId' => 'The identifier for the integration association.
', ], ], 'IntegrationAssociationSummary' => [ 'base' => 'Contains summary information about the associated AppIntegrations.
', 'refs' => [ 'IntegrationAssociationSummaryList$member' => NULL, ], ], 'IntegrationAssociationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListIntegrationAssociationsResponse$IntegrationAssociationSummaryList' => 'The associations.
', ], ], 'IntegrationType' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationRequest$IntegrationType' => 'The type of information to be ingested.
', 'IntegrationAssociationSummary$IntegrationType' => 'The integration type.
', 'ListIntegrationAssociationsRequest$IntegrationType' => 'The integration type.
', ], ], 'InternalServiceException' => [ 'base' => 'Request processing failed because of an error or failure with the service.
', 'refs' => [], ], 'IntervalDetails' => [ 'base' => 'Information about the interval period to use for returning results.
', 'refs' => [ 'GetMetricDataV2Request$Interval' => 'The interval period and timezone to apply to returned metrics.
IntervalPeriod
: An aggregated grouping applied to request metrics. Valid IntervalPeriod
values are: FIFTEEN_MIN
| THIRTY_MIN
| HOUR
| DAY
| WEEK
| TOTAL
.
For example, if IntervalPeriod
is selected THIRTY_MIN
, StartTime
and EndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL
interval period.
The following list describes restrictions on StartTime
and EndTime
based on which IntervalPeriod
is requested.
FIFTEEN_MIN
: The difference between StartTime
and EndTime
must be less than 3 days.
THIRTY_MIN
: The difference between StartTime
and EndTime
must be less than 3 days.
HOUR
: The difference between StartTime
and EndTime
must be less than 3 days.
DAY
: The difference between StartTime
and EndTime
must be less than 35 days.
WEEK
: The difference between StartTime
and EndTime
must be less than 35 days.
TOTAL
: The difference between StartTime
and EndTime
must be less than 35 days.
TimeZone
: The timezone applied to requested metrics.
IntervalPeriod
: An aggregated grouping applied to request metrics. Valid IntervalPeriod
values are: FIFTEEN_MIN
| THIRTY_MIN
| HOUR
| DAY
| WEEK
| TOTAL
.
For example, if IntervalPeriod
is selected THIRTY_MIN
, StartTime
and EndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL
interval period.
The following list describes restrictions on StartTime
and EndTime
based on what IntervalPeriod
is requested.
FIFTEEN_MIN
: The difference between StartTime
and EndTime
must be less than 3 days.
THIRTY_MIN
: The difference between StartTime
and EndTime
must be less than 3 days.
HOUR
: The difference between StartTime
and EndTime
must be less than 3 days.
DAY
: The difference between StartTime
and EndTime
must be less than 35 days.
WEEK
: The difference between StartTime
and EndTime
must be less than 35 days.
TOTAL
: The difference between StartTime
and EndTime
must be less than 35 days.
The interval period provided in the API request.
', ], ], 'InvalidContactFlowException' => [ 'base' => 'The flow is not valid.
', 'refs' => [], ], 'InvalidContactFlowModuleException' => [ 'base' => 'The problems with the module. Please fix before trying again.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'One or more of the specified parameters are not valid.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'The request is not valid.
', 'refs' => [], ], 'InvalidRequestExceptionReason' => [ 'base' => 'Reason why the request was invalid.
', 'refs' => [ 'InvalidRequestException$Reason' => NULL, ], ], 'InvisibleFieldInfo' => [ 'base' => 'A field that is invisible to an agent.
', 'refs' => [ 'InvisibleTaskTemplateFields$member' => NULL, ], ], 'InvisibleTaskTemplateFields' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateConstraints$InvisibleFields' => 'Lists the fields that are invisible to agents.
', ], ], 'JoinToken' => [ 'base' => NULL, 'refs' => [ 'Attendee$JoinToken' => 'The join token used by the Amazon Chime SDK attendee.
', ], ], 'KeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfig$KeyId' => 'The full ARN of the encryption key.
Be sure to provide the full ARN of the encryption key, not just the ID.
Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT
.
Configuration information of a Kinesis Data Firehose delivery stream.
', 'refs' => [ 'InstanceStorageConfig$KinesisFirehoseConfig' => 'The configuration of the Kinesis Firehose delivery stream.
', ], ], 'KinesisStreamConfig' => [ 'base' => 'Configuration information of a Kinesis data stream.
', 'refs' => [ 'InstanceStorageConfig$KinesisStreamConfig' => 'The configuration of the Kinesis data stream.
', ], ], 'KinesisVideoStreamConfig' => [ 'base' => 'Configuration information of a Kinesis video stream.
', 'refs' => [ 'InstanceStorageConfig$KinesisVideoStreamConfig' => 'The configuration of the Kinesis video stream.
', ], ], 'LargeNextToken' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersV2Request$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.
', 'ListPhoneNumbersV2Response$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRealtimeContactAnalysisSegmentsV2Request$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.
', 'ListRealtimeContactAnalysisSegmentsV2Response$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchAvailablePhoneNumbersRequest$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.
', 'SearchAvailablePhoneNumbersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchContactsRequest$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.
', 'SearchContactsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'LexBot' => [ 'base' => 'Configuration information of an Amazon Lex bot.
', 'refs' => [ 'AssociateBotRequest$LexBot' => NULL, 'AssociateLexBotRequest$LexBot' => 'The Amazon Lex bot to associate with the instance.
', 'DisassociateBotRequest$LexBot' => NULL, 'LexBotConfig$LexBot' => NULL, 'LexBotsList$member' => NULL, ], ], 'LexBotConfig' => [ 'base' => 'Configuration information of an Amazon Lex or Amazon Lex V2 bot.
', 'refs' => [ 'LexBotConfigList$member' => NULL, ], ], 'LexBotConfigList' => [ 'base' => NULL, 'refs' => [ 'ListBotsResponse$LexBots' => 'The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.
', ], ], 'LexBotsList' => [ 'base' => NULL, 'refs' => [ 'ListLexBotsResponse$LexBots' => 'The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.
', ], ], 'LexRegion' => [ 'base' => NULL, 'refs' => [ 'DisassociateLexBotRequest$LexRegion' => 'The Amazon Web Services Region in which the Amazon Lex bot has been created.
', 'LexBot$LexRegion' => 'The Amazon Web Services Region where the Amazon Lex bot was created.
', ], ], 'LexV2Bot' => [ 'base' => 'Configuration information of an Amazon Lex V2 bot.
', 'refs' => [ 'AssociateBotRequest$LexV2Bot' => 'The Amazon Lex V2 bot to associate with the instance.
', 'DisassociateBotRequest$LexV2Bot' => 'The Amazon Lex V2 bot to disassociate from the instance.
', 'LexBotConfig$LexV2Bot' => 'Configuration information of an Amazon Lex V2 bot.
', ], ], 'LexVersion' => [ 'base' => NULL, 'refs' => [ 'ListBotsRequest$LexVersion' => 'The version of Amazon Lex or Amazon Lex V2.
', ], ], 'LimitExceededException' => [ 'base' => 'The allowed limit for the resource has been exceeded.
', 'refs' => [], ], 'ListAgentStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAgentStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAnalyticsDataAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnalyticsDataAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListApprovedOriginsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApprovedOriginsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListBotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBotsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactEvaluationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactEvaluationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactFlowModulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactFlowModulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactFlowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactFlowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactReferencesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactReferencesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDefaultVocabulariesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDefaultVocabulariesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEvaluationFormVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEvaluationFormVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEvaluationFormsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEvaluationFormsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowAssociationResourceType' => [ 'base' => NULL, 'refs' => [ 'BatchGetFlowAssociationRequest$ResourceType' => 'The type of resource association.
', 'FlowAssociationSummary$ResourceType' => 'The type of resource association.
', 'ListFlowAssociationsRequest$ResourceType' => 'A valid resource type.
', ], ], 'ListFlowAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHoursOfOperationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHoursOfOperationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceStorageConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceStorageConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIntegrationAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIntegrationAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLambdaFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLambdaFunctionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLexBotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLexBotsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersSummary' => [ 'base' => 'Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
', 'refs' => [ 'ListPhoneNumbersSummaryList$member' => NULL, ], ], 'ListPhoneNumbersSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersV2Response$ListPhoneNumbersSummaryList' => 'Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.
', ], ], 'ListPhoneNumbersV2Request' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersV2Response' => [ 'base' => NULL, 'refs' => [], ], 'ListPredefinedAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPredefinedAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPromptsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPromptsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListQueueQuickConnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListQueueQuickConnectsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListQueuesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListQuickConnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListQuickConnectsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRealtimeContactAnalysisSegmentsV2Request' => [ 'base' => NULL, 'refs' => [], ], 'ListRealtimeContactAnalysisSegmentsV2Response' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingProfileQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingProfileQueuesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfileApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfileApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfilePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfilePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrafficDistributionGroupUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrafficDistributionGroupUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrafficDistributionGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrafficDistributionGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUseCasesRequest' => [ 'base' => 'Provides summary information about the use cases for the specified integration association.
', 'refs' => [], ], 'ListUseCasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserHierarchyGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserHierarchyGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProficienciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProficienciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListViewVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListViewVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListViewsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListViewsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'RoutingProfile$NumberOfAssociatedQueues' => 'The number of associated queues in routing profile.
', 'RoutingProfile$NumberOfAssociatedUsers' => 'The number of associated users in routing profile.
', ], ], 'MaxResult10' => [ 'base' => NULL, 'refs' => [ 'ListInstanceStorageConfigsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListInstancesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListTrafficDistributionGroupUsersRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListTrafficDistributionGroupsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchAvailablePhoneNumbersRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult100' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataRequest$MaxResults' => 'The maximum number of results to return per page.
', 'GetCurrentUserDataRequest$MaxResults' => 'The maximum number of results to return per page.
', 'GetMetricDataRequest$MaxResults' => 'The maximum number of results to return per page.
', 'GetMetricDataV2Request$MaxResults' => 'The maximum number of results to return per page.
', 'ListDefaultVocabulariesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListEvaluationFormVersionsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListEvaluationFormsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListIntegrationAssociationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListPredefinedAttributesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListQueueQuickConnectsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListRealtimeContactAnalysisSegmentsV2Request$MaxResults' => 'The maximum number of results to return per page.
', 'ListRoutingProfileQueuesRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListTaskTemplatesRequest$MaxResults' => 'The maximum number of results to return per page.
It is not expected that you set this.
The maximum number of results to return per page.
', 'ListUserProficienciesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchContactFlowModulesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchContactFlowsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchContactsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchHoursOfOperationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchPredefinedAttributesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchPromptsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchQuickConnectsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchResourceTagsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchSecurityProfilesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchVocabulariesRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult1000' => [ 'base' => NULL, 'refs' => [ 'ListAgentStatusRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListAnalyticsDataAssociationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListContactFlowModulesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListContactFlowsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListFlowAssociationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListHoursOfOperationsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListPhoneNumbersRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListPhoneNumbersV2Request$MaxResults' => 'The maximum number of results to return per page.
', 'ListPromptsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListQueuesRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListQuickConnectsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListRoutingProfilesRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListSecurityProfileApplicationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListSecurityProfilePermissionsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListSecurityProfilesRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListUserHierarchyGroupsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListUsersRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', ], ], 'MaxResult2' => [ 'base' => NULL, 'refs' => [ 'ListSecurityKeysRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult200' => [ 'base' => NULL, 'refs' => [ 'ListRulesRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult25' => [ 'base' => NULL, 'refs' => [ 'ListApprovedOriginsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListBotsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListLambdaFunctionsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListLexBotsRequest$MaxResults' => 'The maximum number of results to return per page. If no value is specified, the default is 10.
', ], ], 'MaxResult500' => [ 'base' => NULL, 'refs' => [ 'SearchQueuesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchRoutingProfilesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchUsersRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult7' => [ 'base' => NULL, 'refs' => [ 'ListInstanceAttributesRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListViewVersionsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListViewsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', ], ], 'MaximumResultReturnedException' => [ 'base' => 'Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
', 'refs' => [], ], 'MediaConcurrencies' => [ 'base' => NULL, 'refs' => [ 'CreateRoutingProfileRequest$MediaConcurrencies' => 'The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
', 'RoutingProfile$MediaConcurrencies' => 'The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
', 'UpdateRoutingProfileConcurrencyRequest$MediaConcurrencies' => 'The channels that agents can handle in the Contact Control Panel (CCP).
', ], ], 'MediaConcurrency' => [ 'base' => 'Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
', 'refs' => [ 'MediaConcurrencies$member' => NULL, ], ], 'MediaPlacement' => [ 'base' => 'A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
', 'refs' => [ 'Meeting$MediaPlacement' => 'The media placement for the meeting.
', ], ], 'MediaRegion' => [ 'base' => NULL, 'refs' => [ 'Meeting$MediaRegion' => 'The Amazon Web Services Region in which you create the meeting.
', ], ], 'Meeting' => [ 'base' => 'A meeting created using the Amazon Chime SDK.
', 'refs' => [ 'ConnectionData$Meeting' => 'A meeting created using the Amazon Chime SDK.
', ], ], 'MeetingFeatureStatus' => [ 'base' => NULL, 'refs' => [ 'AudioFeatures$EchoReduction' => 'Makes echo reduction available to clients who connect to the meeting.
', ], ], 'MeetingFeaturesConfiguration' => [ 'base' => 'The configuration settings of the features available to a meeting.
', 'refs' => [ 'Meeting$MeetingFeatures' => 'The configuration settings of the features available to a meeting.
', ], ], 'MeetingId' => [ 'base' => NULL, 'refs' => [ 'Meeting$MeetingId' => 'The Amazon Chime SDK meeting ID.
', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConflictException$Message' => NULL, 'ContactFlowNotPublishedException$Message' => NULL, 'ContactNotFoundException$Message' => 'The message.
', 'DestinationNotAllowedException$Message' => 'The message about the outbound calls.
', 'DuplicateResourceException$Message' => NULL, 'IdempotencyException$Message' => NULL, 'InternalServiceException$Message' => 'The message.
', 'InvalidParameterException$Message' => 'The message about the parameters.
', 'InvalidRequestException$Message' => 'The message about the request.
', 'LimitExceededException$Message' => 'The message about the limit.
', 'MaximumResultReturnedException$Message' => NULL, 'OutboundContactNotPermittedException$Message' => 'The message about the contact.
', 'OutputTypeNotFoundException$Message' => NULL, 'PropertyValidationException$Message' => NULL, 'PropertyValidationExceptionProperty$Message' => 'A message describing why the property is not valid.
', 'ResourceConflictException$Message' => NULL, 'ResourceInUseException$Message' => NULL, 'ResourceNotFoundException$Message' => 'The message about the resource.
', 'ResourceNotReadyException$Message' => NULL, 'ServiceQuotaExceededException$Message' => NULL, 'ThrottlingException$Message' => NULL, 'TooManyRequestsException$Message' => NULL, 'UserNotFoundException$Message' => NULL, ], ], 'MetadataUrl' => [ 'base' => NULL, 'refs' => [ 'DownloadUrlMetadata$Url' => 'A pre-signed URL that should be used to download the attached file.
', 'UploadUrlMetadata$Url' => 'A pre-signed S3 URL that should be used for uploading the attached file.
', ], ], 'MetricDataCollectionsV2' => [ 'base' => NULL, 'refs' => [ 'MetricResultV2$Collections' => 'The set of metrics.
', ], ], 'MetricDataV2' => [ 'base' => 'Contains the name, thresholds, and metric filters.
', 'refs' => [ 'MetricDataCollectionsV2$member' => NULL, ], ], 'MetricFilterV2' => [ 'base' => 'Contains information about the filter used when retrieving metrics. MetricFiltersV2
can be used on the following metrics: AVG_AGENT_CONNECTING_TIME
, CONTACTS_CREATED
, CONTACTS_HANDLED
, SUM_CONTACTS_DISCONNECTED
.
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
| OUTBOUND
| TRANSFER
| QUEUE_TRANSFER
| CALLBACK
| API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
| AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
| BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
| API
Contains the filters to be used when returning data.
', ], ], 'MetricInterval' => [ 'base' => 'The interval period with the start and end time for the metrics.
', 'refs' => [ 'MetricResultV2$MetricInterval' => 'The interval period with the start and end time for the metrics.
', ], ], 'MetricNameV2' => [ 'base' => NULL, 'refs' => [ 'MetricV2$Name' => 'The name of the metric.
This parameter is required. The following Required = No is incorrect.
Contains information about the metric results.
', 'refs' => [ 'MetricResultsV2$member' => NULL, ], ], 'MetricResultsV2' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataV2Response$MetricResults' => 'Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.
', ], ], 'MetricV2' => [ 'base' => 'Contains information about the metric.
', 'refs' => [ 'MetricDataV2$Metric' => 'The metric name, thresholds, and metric filters of the returned metric.
', 'MetricsV2$member' => NULL, ], ], 'MetricsV2' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataV2Request$Metrics' => 'The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. For now, this metric only supports the following as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Metric filter:
Valid values: API
| Incoming
| Outbound
| Transfer
| Callback
| Queue_Transfer
| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: Contacts answered in X seconds
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE
is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The minutes.
', ], ], 'MonitorCapability' => [ 'base' => NULL, 'refs' => [ 'AllowedMonitorCapabilities$member' => NULL, ], ], 'MonitorContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'MonitorContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'Contact$Name' => 'The name of the contact.
', 'StartOutboundVoiceContactRequest$Name' => 'The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
', 'StartTaskContactRequest$Name' => 'The name of a task that is shown to an agent in the Contact Control Panel (CCP).
', 'UpdateContactRequest$Name' => 'The name of the contact.
', ], ], 'Name128' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupRequest$Name' => 'The name for the traffic distribution group.
', 'TrafficDistributionGroup$Name' => 'The name of the traffic distribution group.
', 'TrafficDistributionGroupSummary$Name' => 'The name of the traffic distribution group.
', ], ], 'Namespace' => [ 'base' => NULL, 'refs' => [ 'Application$Namespace' => 'Namespace of the application that you want to give access to.
', ], ], 'NewChatCreated' => [ 'base' => NULL, 'refs' => [ 'SendChatIntegrationEventResponse$NewChatCreated' => 'Whether handling the integration event resulted in creating a new chat or acting on existing chat.
', ], ], 'NewSessionDetails' => [ 'base' => 'Payload of chat properties to apply when starting a new contact.
', 'refs' => [ 'SendChatIntegrationEventRequest$NewSessionDetails' => 'Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataRequest$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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
', 'GetCurrentMetricDataResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
', 'GetCurrentUserDataRequest$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.
', 'GetCurrentUserDataResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'GetMetricDataRequest$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.
', 'GetMetricDataResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
', 'ListAgentStatusRequest$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.
', 'ListAgentStatusResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListAnalyticsDataAssociationsRequest$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.
', 'ListAnalyticsDataAssociationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListApprovedOriginsRequest$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.
', 'ListApprovedOriginsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListBotsRequest$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.
', 'ListBotsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListContactEvaluationsRequest$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.
This is not expected to be set because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as null in the response.
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.
', 'ListContactFlowModulesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListContactFlowsRequest$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.
', 'ListContactFlowsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListContactReferencesRequest$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.
This is not expected to be set, because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as null in the response.
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.
', 'ListEvaluationFormVersionsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListEvaluationFormsRequest$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.
', 'ListEvaluationFormsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListFlowAssociationsRequest$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.
', 'ListFlowAssociationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListHoursOfOperationsRequest$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.
', 'ListHoursOfOperationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListInstanceAttributesRequest$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.
', 'ListInstanceAttributesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListInstanceStorageConfigsRequest$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.
', 'ListInstanceStorageConfigsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListInstancesRequest$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.
', 'ListInstancesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListIntegrationAssociationsRequest$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.
', 'ListIntegrationAssociationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListLambdaFunctionsRequest$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.
', 'ListLambdaFunctionsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListLexBotsRequest$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.
', 'ListLexBotsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListPhoneNumbersRequest$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.
', 'ListPhoneNumbersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListPredefinedAttributesRequest$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.
', 'ListPredefinedAttributesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListPromptsRequest$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.
', 'ListPromptsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListQueueQuickConnectsRequest$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.
', 'ListQueueQuickConnectsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListQueuesRequest$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.
', 'ListQueuesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListQuickConnectsRequest$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.
', 'ListQuickConnectsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRoutingProfileQueuesRequest$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.
', 'ListRoutingProfileQueuesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRoutingProfilesRequest$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.
', 'ListRoutingProfilesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRulesRequest$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.
', 'ListRulesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListSecurityKeysRequest$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.
', 'ListSecurityKeysResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListSecurityProfileApplicationsRequest$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.
', 'ListSecurityProfileApplicationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListSecurityProfilePermissionsRequest$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.
', 'ListSecurityProfilePermissionsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListSecurityProfilesRequest$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.
', 'ListSecurityProfilesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListTaskTemplatesRequest$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.
It is not expected that you set this because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as a null in the response.
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.
', 'ListTrafficDistributionGroupUsersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListTrafficDistributionGroupsRequest$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.
', 'ListTrafficDistributionGroupsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListUseCasesRequest$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.
', 'ListUseCasesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListUserHierarchyGroupsRequest$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.
', 'ListUserHierarchyGroupsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListUserProficienciesRequest$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.
', 'ListUserProficienciesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListUsersRequest$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.
', 'ListUsersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'NextToken2500' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataV2Request$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.
', 'GetMetricDataV2Response$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchContactFlowModulesRequest$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.
', 'SearchContactFlowModulesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchContactFlowsRequest$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.
', 'SearchContactFlowsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchHoursOfOperationsRequest$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.
', 'SearchHoursOfOperationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchPredefinedAttributesRequest$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.
', 'SearchPredefinedAttributesResponse$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.
', 'SearchPromptsRequest$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.
', 'SearchPromptsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchQueuesRequest$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.
', 'SearchQueuesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchQuickConnectsRequest$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.
', 'SearchQuickConnectsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchResourceTagsRequest$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.
', 'SearchResourceTagsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchRoutingProfilesRequest$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.
', 'SearchRoutingProfilesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchSecurityProfilesRequest$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.
', 'SearchSecurityProfilesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchUsersRequest$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.
', 'SearchUsersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'NotificationContentType' => [ 'base' => NULL, 'refs' => [ 'SendNotificationActionDefinition$ContentType' => 'Content type format.
', ], ], 'NotificationDeliveryType' => [ 'base' => NULL, 'refs' => [ 'SendNotificationActionDefinition$DeliveryMethod' => 'Notification delivery method.
', ], ], 'NotificationRecipientType' => [ 'base' => 'The type of notification recipient.
', 'refs' => [ 'SendNotificationActionDefinition$Recipient' => 'Notification recipient.
', ], ], 'NumberReference' => [ 'base' => 'Information about a reference when the referenceType
is NUMBER
. Otherwise, null.
Information about a reference when the referenceType
is NUMBER
. Otherwise, null.
The property label of the automation.
', ], ], 'NumericQuestionPropertyValueAutomation' => [ 'base' => 'Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME
, CONTACT_DURATION
, AGENT_INTERACTION_DURATION
, CUSTOMER_HOLD_TIME
have a minimum value of 0 and maximum value of 28800.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS
has a minimum value of 0 and maximum value of 1000.
The property value of the automation.
', ], ], 'OperatingSystem' => [ 'base' => NULL, 'refs' => [ 'DeviceInfo$OperatingSystem' => 'Operating system that the participant used for the call.
', ], ], 'Origin' => [ 'base' => NULL, 'refs' => [ 'AssociateApprovedOriginRequest$Origin' => 'The domain to add to your allow list.
', 'DisassociateApprovedOriginRequest$Origin' => 'The domain URL of the integrated application.
', 'OriginsList$member' => NULL, ], ], 'OriginsList' => [ 'base' => NULL, 'refs' => [ 'ListApprovedOriginsResponse$Origins' => 'The approved origins.
', ], ], 'OutboundCallerConfig' => [ 'base' => 'The outbound caller ID name, number, and outbound whisper flow.
', 'refs' => [ 'CreateQueueRequest$OutboundCallerConfig' => 'The outbound caller ID name, number, and outbound whisper flow.
', 'Queue$OutboundCallerConfig' => 'The outbound caller ID name, number, and outbound whisper flow.
', 'UpdateQueueOutboundCallerConfigRequest$OutboundCallerConfig' => 'The outbound caller ID name, number, and outbound whisper flow.
', ], ], 'OutboundCallerIdName' => [ 'base' => NULL, 'refs' => [ 'OutboundCallerConfig$OutboundCallerIdName' => 'The caller ID name.
', ], ], 'OutboundCallsEnabled' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceRequest$OutboundCallsEnabled' => 'Your contact center allows outbound calls.
', 'Instance$OutboundCallsEnabled' => 'Whether outbound calls are enabled.
', 'InstanceSummary$OutboundCallsEnabled' => 'Whether outbound calls are enabled.
', ], ], 'OutboundContactNotPermittedException' => [ 'base' => 'The contact is not permitted.
', 'refs' => [], ], 'OutputTypeNotFoundException' => [ 'base' => 'Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact flow.
', 'refs' => [], ], 'PEM' => [ 'base' => NULL, 'refs' => [ 'AssociateSecurityKeyRequest$Key' => 'A valid security key in PEM format.
', 'SecurityKey$Key' => 'The key of the security key.
', ], ], 'ParticipantCapabilities' => [ 'base' => 'The configuration for the allowed capabilities for participants present over the call.
', 'refs' => [ 'AgentInfo$Capabilities' => NULL, 'AllowedCapabilities$Customer' => 'Information about the customer\'s video sharing capabilities.
', 'AllowedCapabilities$Agent' => 'Information about the agent\'s video sharing capabilities.
', 'Customer$Capabilities' => NULL, ], ], 'ParticipantDetails' => [ 'base' => 'The customer\'s details.
', 'refs' => [ 'NewSessionDetails$ParticipantDetails' => NULL, 'StartChatContactRequest$ParticipantDetails' => 'Information identifying the participant.
', 'StartWebRTCContactRequest$ParticipantDetails' => NULL, ], ], 'ParticipantDetailsToAdd' => [ 'base' => 'The details to add for the participant.
', 'refs' => [ 'CreateParticipantRequest$ParticipantDetails' => 'Information identifying the participant.
The only Valid value for ParticipantRole
is CUSTOM_BOT
.
DisplayName
is Required.
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
', 'RealTimeContactAnalysisSegmentAttachments$ParticipantId' => 'The identifier of the participant.
', 'RealTimeContactAnalysisSegmentEvent$ParticipantId' => 'The identifier of the participant.
', 'RealTimeContactAnalysisSegmentTranscript$ParticipantId' => 'The identifier of the participant.
', 'StartChatContactResponse$ParticipantId' => 'The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
', 'StartWebRTCContactResponse$ParticipantId' => 'The identifier for a contact participant. The ParticipantId
for a contact participant is the same throughout the contact lifecycle.
The role of the participant being added.
', 'RealTimeContactAnalysisSegmentAttachments$ParticipantRole' => 'The role of the participant. For example, is it a customer, agent, or system.
', 'RealTimeContactAnalysisSegmentEvent$ParticipantRole' => 'The role of the participant. For example, is it a customer, agent, or system.
', 'RealTimeContactAnalysisSegmentTranscript$ParticipantRole' => 'The role of the participant. For example, is it a customer, agent, or system.
', 'TranscriptCriteria$ParticipantRole' => 'The participant role in a transcript
', ], ], 'ParticipantTimerAction' => [ 'base' => NULL, 'refs' => [ 'ParticipantTimerValue$ParticipantTimerAction' => 'The timer action. Currently only one value is allowed: Unset
. It deletes a timer.
A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400.
', ], ], 'ParticipantTimerConfiguration' => [ 'base' => 'Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
', 'refs' => [ 'ParticipantTimerConfigList$member' => NULL, ], ], 'ParticipantTimerDurationInMinutes' => [ 'base' => NULL, 'refs' => [ 'ParticipantTimerValue$ParticipantTimerDurationInMinutes' => 'The duration of a timer, in minutes.
', ], ], 'ParticipantTimerType' => [ 'base' => NULL, 'refs' => [ 'ParticipantTimerConfiguration$TimerType' => 'The type of timer. IDLE
indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER
indicates the timer applies to automatically disconnecting a chat participant due to idleness.
The value of the timer. Either the timer action (Unset
to delete the timer), or the duration of the timer in minutes. Only one value can be set.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
', 'refs' => [ 'ParticipantTimerConfiguration$TimerValue' => 'The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
', ], ], 'ParticipantToken' => [ 'base' => NULL, 'refs' => [ 'ParticipantTokenCredentials$ParticipantToken' => 'The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
', 'StartChatContactResponse$ParticipantToken' => 'The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
', 'StartWebRTCContactResponse$ParticipantToken' => 'The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.
', ], ], 'ParticipantTokenCredentials' => [ 'base' => 'The credentials used by the participant.
', 'refs' => [ 'CreateParticipantResponse$ParticipantCredentials' => 'The token used by the chat participant to call CreateParticipantConnection
. The participant token is valid for the lifetime of a chat participant.
The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
', ], ], 'PauseContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'PauseContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'Distribution$Percentage' => 'The percentage of the traffic that is distributed, in increments of 10.
', ], ], 'Permission' => [ 'base' => NULL, 'refs' => [ 'ApplicationPermissions$member' => NULL, ], ], 'PermissionsList' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$Permissions' => 'Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.
', 'ListSecurityProfilePermissionsResponse$Permissions' => 'The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.
', 'UpdateSecurityProfileRequest$Permissions' => 'The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.
', ], ], 'PersistentChat' => [ 'base' => 'Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
', 'refs' => [ 'StartChatContactRequest$PersistentChat' => 'Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
', ], ], 'PhoneNumber' => [ 'base' => NULL, 'refs' => [ 'AvailableNumberSummary$PhoneNumber' => 'The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The phone number in E.164 format.
', 'PhoneNumberSummary$PhoneNumber' => 'The phone number.
', 'StartOutboundVoiceContactRequest$DestinationPhoneNumber' => 'The phone number of the customer, in E.164 format.
', 'StartOutboundVoiceContactRequest$SourcePhoneNumber' => 'The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
', 'UserIdentityInfo$Mobile' => 'The user\'s mobile number.
', 'UserPhoneConfig$DeskPhoneNumber' => 'The phone number for the user\'s desk phone.
', ], ], 'PhoneNumberCountryCode' => [ 'base' => NULL, 'refs' => [ 'AvailableNumberSummary$PhoneNumberCountryCode' => 'The ISO country code.
', 'ClaimedPhoneNumberSummary$PhoneNumberCountryCode' => 'The ISO country code.
', 'ListPhoneNumbersSummary$PhoneNumberCountryCode' => 'The ISO country code.
', 'PhoneNumberCountryCodes$member' => NULL, 'PhoneNumberSummary$PhoneNumberCountryCode' => 'The ISO country code.
', 'SearchAvailablePhoneNumbersRequest$PhoneNumberCountryCode' => 'The ISO country code.
', ], ], 'PhoneNumberCountryCodes' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersRequest$PhoneNumberCountryCodes' => 'The ISO country code.
', 'ListPhoneNumbersV2Request$PhoneNumberCountryCodes' => 'The ISO country code.
', ], ], 'PhoneNumberDescription' => [ 'base' => NULL, 'refs' => [ 'ClaimPhoneNumberRequest$PhoneNumberDescription' => 'The description of the phone number.
', 'ClaimedPhoneNumberSummary$PhoneNumberDescription' => 'The description of the phone number.
', 'ImportPhoneNumberRequest$PhoneNumberDescription' => 'The description of the phone number.
', 'ListPhoneNumbersSummary$PhoneNumberDescription' => 'The description of the phone number.
', 'UpdatePhoneNumberMetadataRequest$PhoneNumberDescription' => 'The description of the phone number.
', ], ], 'PhoneNumberId' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumberContactFlowRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'ClaimPhoneNumberResponse$PhoneNumberId' => 'A unique identifier for the phone number.
', 'ClaimedPhoneNumberSummary$PhoneNumberId' => 'A unique identifier for the phone number.
', 'DescribePhoneNumberRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'DisassociatePhoneNumberContactFlowRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'ImportPhoneNumberResponse$PhoneNumberId' => 'A unique identifier for the phone number.
', 'ListPhoneNumbersSummary$PhoneNumberId' => 'A unique identifier for the phone number.
', 'OutboundCallerConfig$OutboundCallerIdNumberId' => 'The caller ID number.
', 'PhoneNumberSummary$Id' => 'The identifier of the phone number.
', 'ReleasePhoneNumberRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'UpdatePhoneNumberMetadataRequest$PhoneNumberId' => 'The Amazon Resource Name (ARN) or resource ID of the phone number.
', 'UpdatePhoneNumberRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'UpdatePhoneNumberResponse$PhoneNumberId' => 'A unique identifier for the phone number.
', ], ], 'PhoneNumberPrefix' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersV2Request$PhoneNumberPrefix' => 'The prefix of the phone number. If provided, it must contain +
as part of the country code.
The prefix of the phone number. If provided, it must contain +
as part of the country code.
Contains information about a phone number for a quick connect.
', 'refs' => [ 'QuickConnectConfig$PhoneConfig' => 'The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
', ], ], 'PhoneNumberStatus' => [ 'base' => 'The status of the phone number.
CLAIMED
means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
IN_PROGRESS
means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
FAILED
indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn
value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED
status from a ClaimPhoneNumber
API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
The status of the phone number.
CLAIMED
means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
IN_PROGRESS
means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
FAILED
indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn
value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED
status from a ClaimPhoneNumber
API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
You will not be billed for the phone number during the 1-day period if number claiming fails.
Contains summary information about a phone number for a contact center.
', 'refs' => [ 'PhoneNumberSummaryList$member' => NULL, ], ], 'PhoneNumberSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersResponse$PhoneNumberSummaryList' => 'Information about the phone numbers.
', ], ], 'PhoneNumberType' => [ 'base' => NULL, 'refs' => [ 'AvailableNumberSummary$PhoneNumberType' => 'The type of phone number.
', 'ClaimedPhoneNumberSummary$PhoneNumberType' => 'The type of phone number.
', 'ListPhoneNumbersSummary$PhoneNumberType' => 'The type of phone number.
', 'PhoneNumberSummary$PhoneNumberType' => 'The type of phone number.
', 'PhoneNumberTypes$member' => NULL, 'SearchAvailablePhoneNumbersRequest$PhoneNumberType' => 'The type of phone number.
', ], ], 'PhoneNumberTypes' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersRequest$PhoneNumberTypes' => 'The type of phone number.
We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN
, SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
, it incorrectly lists them as TOLL_FREE
or DID
.
The type of phone number.
', ], ], 'PhoneNumberWorkflowMessage' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberStatus$Message' => 'The status message.
', ], ], 'PhoneNumberWorkflowStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberStatus$Status' => 'The status.
', ], ], 'PhoneType' => [ 'base' => NULL, 'refs' => [ 'UserPhoneConfig$PhoneType' => 'The phone type.
', ], ], 'PlatformName' => [ 'base' => NULL, 'refs' => [ 'DeviceInfo$PlatformName' => 'Name of the platform that the participant used for the call.
', ], ], 'PlatformVersion' => [ 'base' => NULL, 'refs' => [ 'DeviceInfo$PlatformVersion' => 'Version of the platform that the participant used for the call.
', ], ], 'PotentialAudioQualityIssue' => [ 'base' => NULL, 'refs' => [ 'PotentialAudioQualityIssues$member' => NULL, ], ], 'PotentialAudioQualityIssues' => [ 'base' => NULL, 'refs' => [ 'AudioQualityMetricsInfo$PotentialQualityIssues' => 'List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss
| HighRoundTripTime
| HighJitterBuffer
Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
', ], ], 'PredefinedAttribute' => [ 'base' => 'Information about a predefined attribute.
', 'refs' => [ 'DescribePredefinedAttributeResponse$PredefinedAttribute' => 'Information about the predefined attribute.
', 'PredefinedAttributeSearchSummaryList$member' => NULL, ], ], 'PredefinedAttributeName' => [ 'base' => NULL, 'refs' => [ 'AttributeCondition$Name' => 'The name of predefined attribute.
', 'CreatePredefinedAttributeRequest$Name' => 'The name of the predefined attribute.
', 'DeletePredefinedAttributeRequest$Name' => 'The name of the predefined attribute.
', 'DescribePredefinedAttributeRequest$Name' => 'The name of the predefined attribute.
', 'PredefinedAttribute$Name' => 'The name of the predefined attribute.
', 'PredefinedAttributeSummary$Name' => 'The name of the predefined attribute.
', 'UpdatePredefinedAttributeRequest$Name' => 'The name of the predefined attribute.
', 'UserProficiency$AttributeName' => 'The name of user\'s proficiency. You must use name of predefined attribute present in the Amazon Connect instance.
', 'UserProficiencyDisassociate$AttributeName' => 'The name of user\'s proficiency.
', ], ], 'PredefinedAttributeSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'PredefinedAttributeSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return predefined attributes.
', 'refs' => [ 'PredefinedAttributeSearchConditionList$member' => NULL, 'SearchPredefinedAttributesRequest$SearchCriteria' => 'The search criteria to be used to return predefined attributes.
', ], ], 'PredefinedAttributeSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchPredefinedAttributesResponse$PredefinedAttributes' => 'Predefined attributes matched by the search criteria.
', ], ], 'PredefinedAttributeStringValue' => [ 'base' => NULL, 'refs' => [ 'PredefinedAttributeStringValuesList$member' => NULL, 'UserProficiency$AttributeValue' => 'The value of user\'s proficiency. You must use value of predefined attribute present in the Amazon Connect instance.
', 'UserProficiencyDisassociate$AttributeValue' => 'The value of user\'s proficiency.
', ], ], 'PredefinedAttributeStringValuesList' => [ 'base' => NULL, 'refs' => [ 'PredefinedAttributeValues$StringList' => 'Predefined attribute values of type string list.
', ], ], 'PredefinedAttributeSummary' => [ 'base' => 'Summary of a predefined attribute.
', 'refs' => [ 'PredefinedAttributeSummaryList$member' => NULL, ], ], 'PredefinedAttributeSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPredefinedAttributesResponse$PredefinedAttributeSummaryList' => 'Summary of the predefined attributes.
', ], ], 'PredefinedAttributeValues' => [ 'base' => 'Information about values of a predefined attribute.
', 'refs' => [ 'CreatePredefinedAttributeRequest$Values' => 'The values of the predefined attribute.
', 'PredefinedAttribute$Values' => 'The values of the predefined attribute.
', 'UpdatePredefinedAttributeRequest$Values' => 'The values of the predefined attribute.
', ], ], 'Prefix' => [ 'base' => NULL, 'refs' => [ 'KinesisVideoStreamConfig$Prefix' => 'The prefix of the video stream.
', 'S3Config$BucketPrefix' => 'The S3 bucket prefix.
', ], ], 'Priority' => [ 'base' => NULL, 'refs' => [ 'RoutingProfileQueueConfig$Priority' => 'The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
', 'RoutingProfileQueueConfigSummary$Priority' => 'The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
', ], ], 'ProblemDetail' => [ 'base' => 'Information about a problem detail.
', 'refs' => [ 'Problems$member' => NULL, ], ], 'ProblemMessageString' => [ 'base' => NULL, 'refs' => [ 'ProblemDetail$message' => 'The problem detail\'s message.
', ], ], 'Problems' => [ 'base' => NULL, 'refs' => [ 'InvalidContactFlowException$problems' => 'The problems with the flow. Please fix before trying again.
', 'InvalidContactFlowModuleException$Problems' => NULL, ], ], 'ProficiencyLevel' => [ 'base' => NULL, 'refs' => [ 'AttributeCondition$ProficiencyLevel' => 'The proficiency level of the condition.
', 'UserProficiency$Level' => 'The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
', ], ], 'ProficiencyValue' => [ 'base' => NULL, 'refs' => [ 'AttributeCondition$Value' => 'The value of predefined attribute.
', ], ], 'Prompt' => [ 'base' => 'Information about a prompt.
', 'refs' => [ 'DescribePromptResponse$Prompt' => 'Information about the prompt.
', 'PromptList$member' => NULL, ], ], 'PromptDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePromptRequest$Description' => 'The description of the prompt.
', 'Prompt$Description' => 'The description of the prompt.
', 'UpdatePromptRequest$Description' => 'A description of the prompt.
', ], ], 'PromptId' => [ 'base' => NULL, 'refs' => [ 'CreatePromptResponse$PromptId' => 'A unique identifier for the prompt.
', 'DeletePromptRequest$PromptId' => 'A unique identifier for the prompt.
', 'DescribePromptRequest$PromptId' => 'A unique identifier for the prompt.
', 'GetPromptFileRequest$PromptId' => 'A unique identifier for the prompt.
', 'Prompt$PromptId' => 'A unique identifier for the prompt.
', 'PromptSummary$Id' => 'The identifier of the prompt.
', 'UpdatePromptRequest$PromptId' => 'A unique identifier for the prompt.
', 'UpdatePromptResponse$PromptId' => 'A unique identifier for the prompt.
', ], ], 'PromptList' => [ 'base' => NULL, 'refs' => [ 'SearchPromptsResponse$Prompts' => 'Information about the prompts.
', ], ], 'PromptName' => [ 'base' => NULL, 'refs' => [ 'PromptSummary$Name' => 'The name of the prompt.
', ], ], 'PromptPresignedUrl' => [ 'base' => NULL, 'refs' => [ 'GetPromptFileResponse$PromptPresignedUrl' => 'A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.
', ], ], 'PromptSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'PromptSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'PromptSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'PromptSearchCriteria' => [ 'base' => 'The search criteria to be used to return prompts.
', 'refs' => [ 'PromptSearchConditionList$member' => NULL, 'SearchPromptsRequest$SearchCriteria' => 'The search criteria to be used to return prompts.
', ], ], 'PromptSearchFilter' => [ 'base' => 'Filters to be applied to search results.
', 'refs' => [ 'SearchPromptsRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'PromptSummary' => [ 'base' => 'Contains information about the prompt.
', 'refs' => [ 'PromptSummaryList$member' => NULL, ], ], 'PromptSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPromptsResponse$PromptSummaryList' => 'Information about the prompts.
', ], ], 'PropertyValidationException' => [ 'base' => 'The property is not valid.
', 'refs' => [], ], 'PropertyValidationExceptionProperty' => [ 'base' => 'Contains information about why a property is not valid.
', 'refs' => [ 'PropertyValidationExceptionPropertyList$member' => NULL, ], ], 'PropertyValidationExceptionPropertyList' => [ 'base' => NULL, 'refs' => [ 'PropertyValidationException$PropertyList' => NULL, ], ], 'PropertyValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'PropertyValidationExceptionProperty$Reason' => 'Why the property is not valid.
', ], ], 'PutUserStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutUserStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'QualityMetrics' => [ 'base' => 'Information about the quality of the participant\'s media connection.
', 'refs' => [ 'Contact$QualityMetrics' => 'Information about the quality of the participant\'s media connection.
', ], ], 'Queue' => [ 'base' => 'Contains information about a queue.
', 'refs' => [ 'DescribeQueueResponse$Queue' => 'The name of the queue.
', 'QueueSearchSummaryList$member' => NULL, ], ], 'QueueDescription' => [ 'base' => NULL, 'refs' => [ 'CreateQueueRequest$Description' => 'The description of the queue.
', 'Queue$Description' => 'The description of the queue.
', 'UpdateQueueNameRequest$Description' => 'The description of the queue.
', ], ], 'QueueId' => [ 'base' => NULL, 'refs' => [ 'AssociateQueueQuickConnectsRequest$QueueId' => 'The identifier for the queue.
', 'AssociatedQueueIdList$member' => NULL, 'ContactDataRequest$QueueId' => 'The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.
', 'ContactSearchSummaryQueueInfo$Id' => 'The unique identifier for the queue.
', 'CreateQueueResponse$QueueId' => 'The identifier for the queue.
', 'CreateRoutingProfileRequest$DefaultOutboundQueueId' => 'The default outbound queue for the routing profile.
', 'DeleteQueueRequest$QueueId' => 'The identifier for the queue.
', 'DescribeQueueRequest$QueueId' => 'The identifier for the queue.
', 'DisassociateQueueQuickConnectsRequest$QueueId' => 'The identifier for the queue.
', 'ListQueueQuickConnectsRequest$QueueId' => 'The identifier for the queue.
', 'Queue$QueueId' => 'The identifier for the queue.
', 'QueueIdList$member' => NULL, 'QueueInfo$Id' => 'The unique identifier for the queue.
', 'QueueQuickConnectConfig$QueueId' => 'The identifier for the queue.
', 'QueueReference$Id' => 'The identifier of the queue.
', 'QueueSummary$Id' => 'The identifier of the queue.
', 'Queues$member' => NULL, 'RoutingProfile$DefaultOutboundQueueId' => 'The identifier of the default outbound queue for this routing profile.
', 'RoutingProfileQueueConfigSummary$QueueId' => 'The identifier for the queue.
', 'RoutingProfileQueueReference$QueueId' => 'The identifier for the queue.
', 'StartOutboundVoiceContactRequest$QueueId' => 'The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.
', 'TransferContactRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueHoursOfOperationRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueMaxContactsRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueNameRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueOutboundCallerConfigRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueStatusRequest$QueueId' => 'The identifier for the queue.
', 'UpdateRoutingProfileDefaultOutboundQueueRequest$DefaultOutboundQueueId' => 'The identifier for the default outbound queue.
', ], ], 'QueueIdList' => [ 'base' => NULL, 'refs' => [ 'SearchCriteria$QueueIds' => 'The list of queue IDs associated with contacts.
', ], ], 'QueueInfo' => [ 'base' => 'If this contact was queued, this contains information about the queue.
', 'refs' => [ 'Contact$QueueInfo' => 'If this contact was queued, this contains information about the queue.
', ], ], 'QueueMaxContacts' => [ 'base' => NULL, 'refs' => [ 'CreateQueueRequest$MaxContacts' => 'The maximum number of contacts that can be in the queue before it is considered full.
', 'Queue$MaxContacts' => 'The maximum number of contacts that can be in the queue before it is considered full.
', 'UpdateQueueMaxContactsRequest$MaxContacts' => 'The maximum number of contacts that can be in the queue before it is considered full.
', ], ], 'QueueName' => [ 'base' => NULL, 'refs' => [ 'QueueSummary$Name' => 'The name of the queue.
', 'RoutingProfileQueueConfigSummary$QueueName' => 'The name of the queue.
', ], ], 'QueuePriority' => [ 'base' => NULL, 'refs' => [ 'Contact$QueuePriority' => 'An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
', 'UpdateContactRoutingDataRequest$QueuePriority' => 'Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.
', ], ], 'QueueQuickConnectConfig' => [ 'base' => 'Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
', 'refs' => [ 'QuickConnectConfig$QueueConfig' => 'The queue configuration. This is required only if QuickConnectType is QUEUE.
', ], ], 'QueueReference' => [ 'base' => 'Contains information about a queue resource for which metrics are returned.
', 'refs' => [ 'AgentContactReference$Queue' => NULL, 'Dimensions$Queue' => 'Information about the queue for which metrics are returned.
', ], ], 'QueueSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'QueueSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'QueueSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'QueueSearchCriteria' => [ 'base' => 'The search criteria to be used to return queues.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return queues.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
', 'refs' => [ 'SearchQueuesRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'QueueSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchQueuesResponse$Queues' => 'Information about the queues.
', ], ], 'QueueStatus' => [ 'base' => NULL, 'refs' => [ 'Queue$Status' => 'The status of the queue.
', 'UpdateQueueStatusRequest$Status' => 'The status of the queue.
', ], ], 'QueueSummary' => [ 'base' => 'Contains summary information about a queue.
', 'refs' => [ 'QueueSummaryList$member' => NULL, ], ], 'QueueSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListQueuesResponse$QueueSummaryList' => 'Information about the queues.
', ], ], 'QueueTimeAdjustmentSeconds' => [ 'base' => NULL, 'refs' => [ 'Contact$QueueTimeAdjustmentSeconds' => 'An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
', 'UpdateContactRoutingDataRequest$QueueTimeAdjustmentSeconds' => 'The number of seconds to add or subtract from the contact\'s routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.
', ], ], 'QueueType' => [ 'base' => NULL, 'refs' => [ 'QueueSummary$QueueType' => 'The type of queue.
', 'QueueTypes$member' => NULL, ], ], 'QueueTypes' => [ 'base' => NULL, 'refs' => [ 'ListQueuesRequest$QueueTypes' => 'The type of queue.
', ], ], 'Queues' => [ 'base' => NULL, 'refs' => [ 'Filters$Queues' => 'The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData
API in particular requires a queue when you include a Filter
in your request.
A list of up to 100 queues or ARNs.
', ], ], 'QuickConnect' => [ 'base' => 'Contains information about a quick connect.
', 'refs' => [ 'DescribeQuickConnectResponse$QuickConnect' => 'Information about the quick connect.
', 'QuickConnectSearchSummaryList$member' => NULL, ], ], 'QuickConnectConfig' => [ 'base' => 'Contains configuration settings for a quick connect.
', 'refs' => [ 'CreateQuickConnectRequest$QuickConnectConfig' => 'Configuration settings for the quick connect.
', 'QuickConnect$QuickConnectConfig' => 'Contains information about the quick connect.
', 'UpdateQuickConnectConfigRequest$QuickConnectConfig' => 'Information about the configuration settings for the quick connect.
', ], ], 'QuickConnectDescription' => [ 'base' => NULL, 'refs' => [ 'CreateQuickConnectRequest$Description' => 'The description of the quick connect.
', 'QuickConnect$Description' => 'The description.
', ], ], 'QuickConnectId' => [ 'base' => NULL, 'refs' => [ 'CreateQuickConnectResponse$QuickConnectId' => 'The identifier for the quick connect.
', 'DeleteQuickConnectRequest$QuickConnectId' => 'The identifier for the quick connect.
', 'DescribeQuickConnectRequest$QuickConnectId' => 'The identifier for the quick connect.
', 'QuickConnect$QuickConnectId' => 'The identifier for the quick connect.
', 'QuickConnectSummary$Id' => 'The identifier for the quick connect.
', 'QuickConnectsList$member' => NULL, 'StartTaskContactRequest$QuickConnectId' => 'The identifier for the quick connect. Tasks that are created by using QuickConnectId
will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
The identifier for the quick connect.
', 'UpdateQuickConnectNameRequest$QuickConnectId' => 'The identifier for the quick connect.
', ], ], 'QuickConnectName' => [ 'base' => NULL, 'refs' => [ 'CreateQuickConnectRequest$Name' => 'A unique name of the quick connect.
', 'QuickConnect$Name' => 'The name of the quick connect.
', 'QuickConnectSummary$Name' => 'The name of the quick connect.
', 'UpdateQuickConnectNameRequest$Name' => 'The name of the quick connect.
', ], ], 'QuickConnectSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'QuickConnectSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'QuickConnectSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'QuickConnectSearchCriteria' => [ 'base' => 'The search criteria to be used to return quick connects.
', 'refs' => [ 'QuickConnectSearchConditionList$member' => NULL, 'SearchQuickConnectsRequest$SearchCriteria' => 'The search criteria to be used to return quick connects.
', ], ], 'QuickConnectSearchFilter' => [ 'base' => 'Filters to be applied to search results.
', 'refs' => [ 'SearchQuickConnectsRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'QuickConnectSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchQuickConnectsResponse$QuickConnects' => 'Information about the quick connects.
', ], ], 'QuickConnectSummary' => [ 'base' => 'Contains summary information about a quick connect.
', 'refs' => [ 'QuickConnectSummaryList$member' => NULL, ], ], 'QuickConnectSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListQueueQuickConnectsResponse$QuickConnectSummaryList' => 'Information about the quick connects.
', 'ListQuickConnectsResponse$QuickConnectSummaryList' => 'Information about the quick connects.
', ], ], 'QuickConnectType' => [ 'base' => NULL, 'refs' => [ 'QuickConnectConfig$QuickConnectType' => 'The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
', 'QuickConnectSummary$QuickConnectType' => 'The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
', 'QuickConnectTypes$member' => NULL, ], ], 'QuickConnectTypes' => [ 'base' => NULL, 'refs' => [ 'ListQuickConnectsRequest$QuickConnectTypes' => 'The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
', ], ], 'QuickConnectsList' => [ 'base' => NULL, 'refs' => [ 'AssociateQueueQuickConnectsRequest$QuickConnectIds' => 'The quick connects to associate with this queue.
', 'CreateQueueRequest$QuickConnectIds' => 'The quick connects available to agents who are working the queue.
', 'DisassociateQueueQuickConnectsRequest$QuickConnectIds' => 'The quick connects to disassociate from the queue.
', ], ], 'ReadOnlyFieldInfo' => [ 'base' => 'Indicates a field that is read-only to an agent.
', 'refs' => [ 'ReadOnlyTaskTemplateFields$member' => NULL, ], ], 'ReadOnlyTaskTemplateFields' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateConstraints$ReadOnlyFields' => 'Lists the fields that are read-only to agents, and cannot be edited.
', ], ], 'RealTimeContactAnalysisAttachment' => [ 'base' => 'Object that describes attached file.
', 'refs' => [ 'RealTimeContactAnalysisAttachments$member' => NULL, ], ], 'RealTimeContactAnalysisAttachments' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentAttachments$Attachments' => 'List of objects describing an individual attachment.
', ], ], 'RealTimeContactAnalysisCategoryDetails' => [ 'base' => 'Provides information about the category rule that was matched.
', 'refs' => [ 'RealTimeContactAnalysisMatchedDetails$value' => NULL, ], ], 'RealTimeContactAnalysisCategoryName' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisMatchedDetails$key' => NULL, ], ], 'RealTimeContactAnalysisCharacterInterval' => [ 'base' => 'Begin and end offsets for a part of text.
', 'refs' => [ 'RealTimeContactAnalysisCharacterIntervals$member' => NULL, 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets$CharacterOffsets' => 'List of character intervals within transcript content/text.
', 'RealTimeContactAnalysisTranscriptItemWithContent$CharacterOffsets' => NULL, ], ], 'RealTimeContactAnalysisCharacterIntervals' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisTranscriptItemRedaction$CharacterOffsets' => 'List of character intervals each describing a part of the text that was redacted. For OutputType.Raw
, part of the original text that contains data that can be redacted. For OutputType.Redacted
, part of the string with redaction tag.
The type of content of the item. For example, text/plain
.
Type of the event. For example, application/vnd.amazonaws.connect.event.participant.left
.
The identifier of the segment.
', 'RealTimeContactAnalysisSegmentEvent$Id' => 'The identifier of the contact event.
', 'RealTimeContactAnalysisSegmentTranscript$Id' => 'The identifier of the transcript.
', 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets$Id' => 'Transcript identifier. Matches the identifier from one of the TranscriptSegments.
', 'RealTimeContactAnalysisTranscriptItemWithContent$Id' => 'Transcript identifier. Matches the identifier from one of the TranscriptSegments.
', ], ], 'RealTimeContactAnalysisIssueDetected' => [ 'base' => 'Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
', 'refs' => [ 'RealTimeContactAnalysisIssuesDetected$member' => NULL, ], ], 'RealTimeContactAnalysisIssuesDetected' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentIssues$IssuesDetected' => 'List of the issues detected.
', ], ], 'RealTimeContactAnalysisMatchedDetails' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentCategories$MatchedDetails' => 'Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.
', ], ], 'RealTimeContactAnalysisOffset' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisCharacterInterval$BeginOffsetChar' => 'The beginning of the character interval.
', 'RealTimeContactAnalysisCharacterInterval$EndOffsetChar' => 'The end of the character interval.
', ], ], 'RealTimeContactAnalysisOutputType' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Request$OutputType' => 'The Contact Lens output type to be returned.
', ], ], 'RealTimeContactAnalysisPointOfInterest' => [ 'base' => 'The section of the contact transcript segment that category rule was detected.
', 'refs' => [ 'RealTimeContactAnalysisPointsOfInterest$member' => NULL, ], ], 'RealTimeContactAnalysisPointsOfInterest' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisCategoryDetails$PointsOfInterest' => 'List of PointOfInterest - objects describing a single match of a rule.
', ], ], 'RealTimeContactAnalysisSegmentAttachments' => [ 'base' => 'Segment containing list of attachments.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Attachments' => 'The analyzed attachments.
', ], ], 'RealTimeContactAnalysisSegmentCategories' => [ 'base' => 'The matched category rules.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Categories' => NULL, ], ], 'RealTimeContactAnalysisSegmentEvent' => [ 'base' => 'Segment type describing a contact event.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Event' => NULL, ], ], 'RealTimeContactAnalysisSegmentIssues' => [ 'base' => 'Segment type containing a list of detected issues.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Issues' => NULL, ], ], 'RealTimeContactAnalysisSegmentTranscript' => [ 'base' => 'The analyzed transcript segment.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Transcript' => NULL, ], ], 'RealTimeContactAnalysisSegmentType' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentTypes$member' => NULL, ], ], 'RealTimeContactAnalysisSegmentTypes' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Request$SegmentTypes' => 'Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.
', ], ], 'RealTimeContactAnalysisSentimentLabel' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentTranscript$Sentiment' => 'The sentiment detected for this piece of transcript.
', ], ], 'RealTimeContactAnalysisStatus' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Response$Status' => 'Status of real-time contact analysis.
', ], ], 'RealTimeContactAnalysisSupportedChannel' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Response$Channel' => 'The channel of the contact. Voice
will not be returned.
Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime
', 'refs' => [ 'RealTimeContactAnalysisSegmentAttachments$Time' => 'Field describing the time of the event. It can have different representations of time.
', 'RealTimeContactAnalysisSegmentEvent$Time' => 'Field describing the time of the event. It can have different representations of time.
', 'RealTimeContactAnalysisSegmentTranscript$Time' => 'Field describing the time of the event. It can have different representations of time.
', ], ], 'RealTimeContactAnalysisTimeInstant' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisTimeData$AbsoluteTime' => 'Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
', ], ], 'RealTimeContactAnalysisTranscriptContent' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentTranscript$Content' => 'The content of the transcript. Can be redacted.
', 'RealTimeContactAnalysisTranscriptItemWithContent$Content' => 'Part of the transcript content that contains identified issue. Can be redacted
', ], ], 'RealTimeContactAnalysisTranscriptItemRedaction' => [ 'base' => 'Object describing redaction applied to the segment.
', 'refs' => [ 'RealTimeContactAnalysisSegmentTranscript$Redaction' => 'Object describing redaction that was applied to the transcript. If transcript has the field it means part of the transcript was redacted.
', ], ], 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets' => [ 'base' => 'Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a RealTimeContactAnalysisPointOfInterest
in Category.MatchedDetails
would have character interval describing part of the text that matched category.
Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from.
', 'refs' => [ 'RealTimeContactAnalysisTranscriptItemsWithContent$member' => NULL, ], ], 'RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisPointOfInterest$TranscriptItems' => 'List of the transcript items (segments) that are associated with a given point of interest.
', ], ], 'RealTimeContactAnalysisTranscriptItemsWithContent' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisIssueDetected$TranscriptItems' => 'List of the transcript items (segments) that are associated with a given issue.
', ], ], 'RealtimeContactAnalysisSegment' => [ 'base' => 'An analyzed segment for a real-time analysis session.
', 'refs' => [ 'RealtimeContactAnalysisSegments$member' => NULL, ], ], 'RealtimeContactAnalysisSegments' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Response$Segments' => 'An analyzed transcript or category.
', ], ], 'Reference' => [ 'base' => 'Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
', 'refs' => [ 'ContactReferences$value' => NULL, ], ], 'ReferenceId' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$RefId' => 'The identifier of the question. An identifier must be unique within the evaluation form.
', 'EvaluationFormSection$RefId' => 'The identifier of the section. An identifier must be unique within the evaluation form.
', 'EvaluationFormSingleSelectQuestionAutomation$DefaultOptionRefId' => 'The identifier of the default answer option, when none of the automation options match the criteria.
', 'EvaluationFormSingleSelectQuestionOption$RefId' => 'The identifier of the answer option. An identifier must be unique within the question.
', 'SingleSelectQuestionRuleCategoryAutomation$OptionRefId' => 'The identifier of the answer option.
', ], ], 'ReferenceKey' => [ 'base' => NULL, 'refs' => [ 'AttachmentReference$Name' => 'Identifier of the attachment reference.
', 'ContactReferences$key' => NULL, 'DateReference$Name' => 'Identifier of the date reference.
', 'EmailReference$Name' => 'Identifier of the email reference.
', 'NumberReference$Name' => 'Identifier of the number reference.
', 'StringReference$Name' => 'Identifier of the string reference.
', 'UrlReference$Name' => 'Identifier of the URL reference.
', ], ], 'ReferenceStatus' => [ 'base' => NULL, 'refs' => [ 'AttachmentReference$Status' => 'Status of the attachment reference type.
', ], ], 'ReferenceSummary' => [ 'base' => 'Contains summary information about a reference. ReferenceSummary
contains only one non null field between the URL and attachment based on the reference type.
Information about the flows.
', ], ], 'ReferenceType' => [ 'base' => NULL, 'refs' => [ 'Reference$Type' => 'The type of the reference. DATE
must be of type Epoch timestamp.
The type of reference.
', ], ], 'ReferenceValue' => [ 'base' => NULL, 'refs' => [ 'AttachmentReference$Value' => 'The location path of the attachment reference.
', 'DateReference$Value' => 'A valid date.
', 'EmailReference$Value' => 'A valid email address.
', 'NumberReference$Value' => 'A valid number.
', 'Reference$Value' => 'A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
', 'StringReference$Value' => 'A valid string.
', 'UrlReference$Value' => 'A valid URL.
', ], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'AgentStatusSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'GetPromptFileResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HierarchyGroup$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HierarchyGroupSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HierarchyLevel$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HoursOfOperation$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HoursOfOperationSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListQueueQuickConnectsResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListRoutingProfileQueuesResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListSecurityProfileApplicationsResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListSecurityProfilePermissionsResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListUserProficienciesResponse$LastModifiedRegion' => 'The region in which a user\'s proficiencies were last modified.
', 'PredefinedAttribute$LastModifiedRegion' => 'Last modified region.
', 'PredefinedAttributeSummary$LastModifiedRegion' => 'Last modified region.
', 'Prompt$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'PromptSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'Queue$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'QueueSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'QuickConnect$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'QuickConnectSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'RoutingProfile$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'RoutingProfileSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'SecurityProfile$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'SecurityProfileSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'User$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'UserSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', ], ], 'RehydrationType' => [ 'base' => NULL, 'refs' => [ 'CreatePersistentContactAssociationRequest$RehydrationType' => 'The contactId chosen for rehydration depends on the type chosen.
ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId
of the past ended chat session in the sourceContactId
field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.
FROM_SEGMENT
: Rehydrates a chat from the specified past chat contact provided in the sourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:
Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:
Configuration
SourceContactId = "C2"
RehydrationType = "FROM_SEGMENT"
Expected behavior
This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.
Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:
Configuration
SourceContactId = "C1"
RehydrationType = "ENTIRE_PAST_SESSION"
Expected behavior
This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId
of the past ended chat session in the sourceContactId
field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat.
FROM_SEGMENT
: Rehydrates a chat from the past chat contact that is specified in the sourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
', ], ], 'ReleasePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReplicateInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReplicateInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RequestIdentifier' => [ 'base' => NULL, 'refs' => [ 'ContactDataRequest$RequestIdentifier' => 'Identifier to uniquely identify individual requests in the batch.
', 'FailedRequest$RequestIdentifier' => 'Request identifier provided in the API call in the ContactDataRequest to create a contact.
', 'SuccessfulRequest$RequestIdentifier' => 'Request identifier provided in the API call in the ContactDataRequest to create a contact.
', ], ], 'RequiredFieldInfo' => [ 'base' => 'Information about a required field.
', 'refs' => [ 'RequiredTaskTemplateFields$member' => NULL, ], ], 'RequiredTaskTemplateFields' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateConstraints$RequiredFields' => 'Lists the fields that are required to be filled by agents.
', ], ], 'ResourceArnOrId' => [ 'base' => NULL, 'refs' => [ 'FilterV2$FilterKey' => 'The key to use for filtering data. For example, QUEUE
, ROUTING_PROFILE, AGENT
, CHANNEL
, AGENT_HIERARCHY_LEVEL_ONE
, AGENT_HIERARCHY_LEVEL_TWO
, AGENT_HIERARCHY_LEVEL_THREE
, AGENT_HIERARCHY_LEVEL_FOUR
, AGENT_HIERARCHY_LEVEL_FIVE
. There must be at least 1 key and a maximum 5 keys.
The type of comparison. Only "less than" (LT) comparisons are supported.
', ], ], 'ResourceConflictException' => [ 'base' => 'A resource already has that name.
', 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ActivateEvaluationFormRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'ActivateEvaluationFormResponse$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'CreateEvaluationFormResponse$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'DeactivateEvaluationFormRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'DeactivateEvaluationFormResponse$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'DeleteContactEvaluationRequest$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'DeleteEvaluationFormRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'DescribeContactEvaluationRequest$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'DescribeEvaluationFormRequest$EvaluationFormId' => 'A unique identifier for the contact evaluation.
', 'Evaluation$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'EvaluationAnswersInputMap$key' => NULL, 'EvaluationAnswersOutputMap$key' => NULL, 'EvaluationForm$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'EvaluationFormContent$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'EvaluationFormSummary$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'EvaluationFormVersionSummary$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'EvaluationMetadata$ContactAgentId' => 'The identifier of the agent who performed the contact.
', 'EvaluationNotesMap$key' => NULL, 'EvaluationScoresMap$key' => NULL, 'EvaluationSummary$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'EvaluationSummary$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'ListEvaluationFormVersionsRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'StartContactEvaluationRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'StartContactEvaluationResponse$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'SubmitContactEvaluationRequest$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'SubmitContactEvaluationResponse$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'UpdateContactEvaluationRequest$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'UpdateContactEvaluationResponse$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'UpdateEvaluationFormRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'UpdateEvaluationFormResponse$EvaluationFormId' => 'The unique identifier for the evaluation form.
', ], ], 'ResourceInUseException' => [ 'base' => 'That resource is already in use. Please try another.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource was not found.
', 'refs' => [], ], 'ResourceNotReadyException' => [ 'base' => 'The resource is not ready.
', 'refs' => [], ], 'ResourceTagsSearchCriteria' => [ 'base' => 'The search criteria to be used to search tags.
', 'refs' => [ 'SearchResourceTagsRequest$SearchCriteria' => 'The search criteria to be used to return tags.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceInUseException$ResourceType' => 'The type of resource.
', ], ], 'ResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'SearchResourceTagsRequest$ResourceTypes' => 'The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.
', ], ], 'ResumeContactRecordingRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResumeContactRecordingResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResumeContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResumeContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'RoutingCriteria' => [ 'base' => 'Latest routing criteria on the contact.
', 'refs' => [ 'Contact$RoutingCriteria' => 'Latest routing criteria on the contact.
', ], ], 'RoutingCriteriaStepStatus' => [ 'base' => NULL, 'refs' => [ 'Step$Status' => 'Represents status of the Routing step.
', ], ], 'RoutingExpression' => [ 'base' => NULL, 'refs' => [ 'Dimensions$RoutingStepExpression' => 'The expression of a step in a routing criteria.
', 'RoutingExpressions$member' => NULL, ], ], 'RoutingExpressions' => [ 'base' => NULL, 'refs' => [ 'Filters$RoutingStepExpressions' => 'A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.
', ], ], 'RoutingProfile' => [ 'base' => 'Contains information about a routing profile.
', 'refs' => [ 'DescribeRoutingProfileResponse$RoutingProfile' => 'The routing profile.
', 'RoutingProfileList$member' => NULL, ], ], 'RoutingProfileDescription' => [ 'base' => NULL, 'refs' => [ 'CreateRoutingProfileRequest$Description' => 'Description of the routing profile. Must not be more than 250 characters.
', 'RoutingProfile$Description' => 'The description of the routing profile.
', 'UpdateRoutingProfileNameRequest$Description' => 'The description of the routing profile. Must not be more than 250 characters.
', ], ], 'RoutingProfileId' => [ 'base' => NULL, 'refs' => [ 'AssociateRoutingProfileQueuesRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'CreateRoutingProfileResponse$RoutingProfileId' => 'The identifier of the routing profile.
', 'CreateUserRequest$RoutingProfileId' => 'The identifier of the routing profile for the user.
', 'DeleteRoutingProfileRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'DescribeRoutingProfileRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'DisassociateRoutingProfileQueuesRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'ListRoutingProfileQueuesRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'RoutingProfile$RoutingProfileId' => 'The identifier of the routing profile.
', 'RoutingProfileReference$Id' => 'The identifier of the routing profile.
', 'RoutingProfileSummary$Id' => 'The identifier of the routing profile.
', 'RoutingProfiles$member' => NULL, 'UpdateRoutingProfileAgentAvailabilityTimerRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateRoutingProfileConcurrencyRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateRoutingProfileDefaultOutboundQueueRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateRoutingProfileNameRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateRoutingProfileQueuesRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateUserRoutingProfileRequest$RoutingProfileId' => 'The identifier of the routing profile for the user.
', 'User$RoutingProfileId' => 'The identifier of the routing profile for the user.
', 'UserSearchSummary$RoutingProfileId' => 'The identifier of the user\'s routing profile.
', ], ], 'RoutingProfileList' => [ 'base' => NULL, 'refs' => [ 'SearchRoutingProfilesResponse$RoutingProfiles' => 'Information about the routing profiles.
', ], ], 'RoutingProfileName' => [ 'base' => NULL, 'refs' => [ 'CreateRoutingProfileRequest$Name' => 'The name of the routing profile. Must not be more than 127 characters.
', 'RoutingProfile$Name' => 'The name of the routing profile.
', 'RoutingProfileSummary$Name' => 'The name of the routing profile.
', 'UpdateRoutingProfileNameRequest$Name' => 'The name of the routing profile. Must not be more than 127 characters.
', ], ], 'RoutingProfileQueueConfig' => [ 'base' => 'Contains information about the queue and channel for which priority and delay can be set.
', 'refs' => [ 'RoutingProfileQueueConfigList$member' => NULL, ], ], 'RoutingProfileQueueConfigList' => [ 'base' => NULL, 'refs' => [ 'AssociateRoutingProfileQueuesRequest$QueueConfigs' => 'The queues to associate with this routing profile.
', 'CreateRoutingProfileRequest$QueueConfigs' => 'The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig
objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.
The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
', ], ], 'RoutingProfileQueueConfigSummary' => [ 'base' => 'Contains summary information about a routing profile queue.
', 'refs' => [ 'RoutingProfileQueueConfigSummaryList$member' => NULL, ], ], 'RoutingProfileQueueConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListRoutingProfileQueuesResponse$RoutingProfileQueueConfigSummaryList' => 'Information about the routing profiles.
', ], ], 'RoutingProfileQueueReference' => [ 'base' => 'Contains the channel and queue identifier for a routing profile.
', 'refs' => [ 'RoutingProfileQueueConfig$QueueReference' => 'Contains information about a queue resource.
', 'RoutingProfileQueueReferenceList$member' => NULL, ], ], 'RoutingProfileQueueReferenceList' => [ 'base' => NULL, 'refs' => [ 'DisassociateRoutingProfileQueuesRequest$QueueReferences' => 'The queues to disassociate from this routing profile.
', ], ], 'RoutingProfileReference' => [ 'base' => 'Information about the routing profile assigned to the user.
', 'refs' => [ 'Dimensions$RoutingProfile' => NULL, 'UserData$RoutingProfile' => 'Information about the routing profile that is assigned to the user.
', ], ], 'RoutingProfileSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'RoutingProfileSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'RoutingProfileSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'RoutingProfileSearchCriteria' => [ 'base' => 'The search criteria to be used to return routing profiles.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return routing profiles.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
', 'refs' => [ 'SearchRoutingProfilesRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'RoutingProfileSummary' => [ 'base' => 'Contains summary information about a routing profile.
', 'refs' => [ 'RoutingProfileSummaryList$member' => NULL, ], ], 'RoutingProfileSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListRoutingProfilesResponse$RoutingProfileSummaryList' => 'Information about the routing profiles.
', ], ], 'RoutingProfiles' => [ 'base' => NULL, 'refs' => [ 'Filters$RoutingProfiles' => 'A list of up to 100 routing profile IDs or ARNs.
', 'UserDataFilters$RoutingProfiles' => 'A list of up to 100 routing profile IDs or ARNs.
', ], ], 'Rule' => [ 'base' => 'Information about a rule.
', 'refs' => [ 'DescribeRuleResponse$Rule' => 'Information about the rule.
', ], ], 'RuleAction' => [ 'base' => 'Information about the action to be performed when a rule is triggered.
', 'refs' => [ 'RuleActions$member' => NULL, ], ], 'RuleActions' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$Actions' => 'A list of actions to be run when the rule is triggered.
', 'Rule$Actions' => 'A list of actions to be run when the rule is triggered.
', 'UpdateRuleRequest$Actions' => 'A list of actions to be run when the rule is triggered.
', ], ], 'RuleFunction' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$Function' => 'The conditions of the rule.
', 'Rule$Function' => 'The conditions of the rule.
', 'UpdateRuleRequest$Function' => 'The conditions of the rule.
', ], ], 'RuleId' => [ 'base' => NULL, 'refs' => [ 'CreateRuleResponse$RuleId' => 'A unique identifier for the rule.
', 'DeleteRuleRequest$RuleId' => 'A unique identifier for the rule.
', 'DescribeRuleRequest$RuleId' => 'A unique identifier for the rule.
', 'Rule$RuleId' => 'A unique identifier for the rule.
', 'RuleSummary$RuleId' => 'A unique identifier for the rule.
', 'UpdateRuleRequest$RuleId' => 'A unique identifier for the rule.
', ], ], 'RuleName' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$Name' => 'A unique name for the rule.
', 'Rule$Name' => 'The name of the rule.
', 'RuleSummary$Name' => 'The name of the rule.
', 'UpdateRuleRequest$Name' => 'The name of the rule. You can change the name only if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
The publish status of the rule.
', 'ListRulesRequest$PublishStatus' => 'The publish status of the rule.
', 'Rule$PublishStatus' => 'The publish status of the rule.
', 'RuleSummary$PublishStatus' => 'The publish status of the rule.
', 'UpdateRuleRequest$PublishStatus' => 'The publish status of the rule.
', ], ], 'RuleSummary' => [ 'base' => 'A list of ActionTypes
associated with a rule.
Summary information about a rule.
', ], ], 'RuleTriggerEventSource' => [ 'base' => 'The name of the event source. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
| OnContactEvaluationSubmit
| OnMetricDataUpdate
.
The event source to trigger the rule.
', 'Rule$TriggerEventSource' => 'The event source to trigger the rule.
', ], ], 'S3Config' => [ 'base' => 'Information about the Amazon Simple Storage Service (Amazon S3) storage type.
', 'refs' => [ 'InstanceStorageConfig$S3Config' => 'The S3 bucket configuration.
', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'CreatePromptRequest$S3Uri' => 'The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
', 'UpdatePromptRequest$S3Uri' => 'The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
', ], ], 'SearchAvailablePhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchAvailablePhoneNumbersResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactFlowModulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactFlowModulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactFlowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactFlowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactsMatchType' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributes$MatchType' => 'The match type combining search criteria using multiple searchable contact attributes.
', 'Transcript$MatchType' => 'The match type combining search criteria using multiple transcript criteria.
', 'TranscriptCriteria$MatchType' => 'The match type combining search criteria using multiple search texts in a transcript criteria.
', ], ], 'SearchContactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactsTimeRange' => [ 'base' => 'A structure of time range that you want to search results.
', 'refs' => [ 'SearchContactsRequest$TimeRange' => 'Time range that you want to search results.
', ], ], 'SearchContactsTimeRangeType' => [ 'base' => NULL, 'refs' => [ 'SearchContactsTimeRange$Type' => 'The type of timestamp to search.
', ], ], 'SearchCriteria' => [ 'base' => 'A structure of search criteria to be used to return contacts.
', 'refs' => [ 'SearchContactsRequest$SearchCriteria' => 'The search criteria to be used to return contacts.
', ], ], 'SearchHoursOfOperationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchHoursOfOperationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchPredefinedAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchPredefinedAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchPromptsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchPromptsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchQueuesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchQuickConnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchQuickConnectsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchResourceTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchResourceTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchRoutingProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchRoutingProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchSecurityProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchSecurityProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchText' => [ 'base' => NULL, 'refs' => [ 'SearchTextList$member' => NULL, ], ], 'SearchTextList' => [ 'base' => NULL, 'refs' => [ 'TranscriptCriteria$SearchText' => 'The words or phrases used to search within a transcript.
', ], ], 'SearchUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchVocabulariesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchVocabulariesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchableContactAttributeKey' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributesCriteria$Key' => 'The key containing a searchable user-defined contact attribute.
', ], ], 'SearchableContactAttributeValue' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributeValueList$member' => NULL, ], ], 'SearchableContactAttributeValueList' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributesCriteria$Values' => 'The list of values to search for within a user-defined contact attribute.
', ], ], 'SearchableContactAttributes' => [ 'base' => 'A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
', 'refs' => [ 'SearchCriteria$SearchableContactAttributes' => 'The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by customer contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes
in a search request, the GetContactAttributes
action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
The search criteria based on user-defned contact attribute key and values to search on.
', 'refs' => [ 'SearchableContactAttributesCriteriaList$member' => NULL, ], ], 'SearchableContactAttributesCriteriaList' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributes$Criteria' => 'The list of criteria based on user-defined contact attributes that are configured for contact search.
', ], ], 'SearchableQueueType' => [ 'base' => NULL, 'refs' => [ 'QueueSearchCriteria$QueueTypeCondition' => 'The type of queue.
', ], ], 'SecurityKey' => [ 'base' => 'Configuration information of the security key.
', 'refs' => [ 'SecurityKeysList$member' => NULL, ], ], 'SecurityKeysList' => [ 'base' => NULL, 'refs' => [ 'ListSecurityKeysResponse$SecurityKeys' => 'The security keys.
', ], ], 'SecurityProfile' => [ 'base' => 'Contains information about a security profile.
', 'refs' => [ 'DescribeSecurityProfileResponse$SecurityProfile' => 'The security profile.
', ], ], 'SecurityProfileDescription' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$Description' => 'The description of the security profile.
', 'SecurityProfile$Description' => 'The description of the security profile.
', 'SecurityProfileSearchSummary$Description' => 'The description of the security profile.
', 'UpdateSecurityProfileRequest$Description' => 'The description of the security profile.
', ], ], 'SecurityProfileId' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileResponse$SecurityProfileId' => 'The identifier for the security profle.
', 'DeleteSecurityProfileRequest$SecurityProfileId' => 'The identifier for the security profle.
', 'DescribeSecurityProfileRequest$SecurityProfileId' => 'The identifier for the security profle.
', 'ListSecurityProfileApplicationsRequest$SecurityProfileId' => 'The identifier for the security profle.
', 'ListSecurityProfilePermissionsRequest$SecurityProfileId' => 'The identifier for the security profle.
', 'SecurityProfile$Id' => 'The identifier for the security profile.
', 'SecurityProfileIds$member' => NULL, 'SecurityProfileSearchSummary$Id' => 'The identifier of the security profile.
', 'SecurityProfileSummary$Id' => 'The identifier of the security profile.
', 'UpdateSecurityProfileRequest$SecurityProfileId' => 'The identifier for the security profle.
', ], ], 'SecurityProfileIds' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$SecurityProfileIds' => 'The identifier of the security profile for the user.
', 'UpdateUserSecurityProfilesRequest$SecurityProfileIds' => 'The identifiers of the security profiles for the user.
', 'User$SecurityProfileIds' => 'The identifiers of the security profiles for the user.
', 'UserSearchSummary$SecurityProfileIds' => 'The identifiers of the user\'s security profiles.
', ], ], 'SecurityProfileName' => [ 'base' => NULL, 'refs' => [ 'SecurityProfile$SecurityProfileName' => 'The name for the security profile.
', 'SecurityProfileSearchSummary$SecurityProfileName' => 'The name of the security profile.
', 'SecurityProfileSummary$Name' => 'The name of the security profile.
', ], ], 'SecurityProfilePermission' => [ 'base' => NULL, 'refs' => [ 'PermissionsList$member' => NULL, ], ], 'SecurityProfilePolicyKey' => [ 'base' => NULL, 'refs' => [ 'AllowedAccessControlTags$key' => NULL, ], ], 'SecurityProfilePolicyValue' => [ 'base' => NULL, 'refs' => [ 'AllowedAccessControlTags$value' => NULL, ], ], 'SecurityProfileSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'SecurityProfileSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'SecurityProfileSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'SecurityProfileSearchCriteria' => [ 'base' => 'The search criteria to be used to return security profiles.
The name
field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return security profiles.
The name
field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The currently supported value for FieldName
: name
Information about the returned security profiles.
', 'refs' => [ 'SecurityProfilesSearchSummaryList$member' => NULL, ], ], 'SecurityProfileSummary' => [ 'base' => 'Contains information about a security profile.
', 'refs' => [ 'SecurityProfileSummaryList$member' => NULL, ], ], 'SecurityProfileSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListSecurityProfilesResponse$SecurityProfileSummaryList' => 'Information about the security profiles.
', ], ], 'SecurityProfilesSearchFilter' => [ 'base' => 'Filters to be applied to search results.
', 'refs' => [ 'SearchSecurityProfilesRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'SecurityProfilesSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchSecurityProfilesResponse$SecurityProfiles' => 'Information about the security profiles.
', ], ], 'SecurityToken' => [ 'base' => NULL, 'refs' => [ 'Credentials$AccessToken' => 'An access token generated for a federated user to access Amazon Connect.
', 'Credentials$RefreshToken' => 'Renews a token generated for a user to access the Amazon Connect instance.
', ], ], 'SegmentAttributeName' => [ 'base' => NULL, 'refs' => [ 'SegmentAttributes$key' => NULL, ], ], 'SegmentAttributeValue' => [ 'base' => 'A value for a segment attribute. This is structured as a map where the key is valueString
and the value is a string.
The value of a segment attribute.
', ], ], 'SegmentAttributes' => [ 'base' => NULL, 'refs' => [ 'Contact$SegmentAttributes' => 'A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide
or connect:SMS
.
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide
.
The types application/vnd.amazonaws.connect.message.interactive
and application/vnd.amazonaws.connect.message.interactive.response
must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes
as { "connect:Subtype": {"valueString" : "connect:Guide" }}
.
Information about the send notification action.
', 'refs' => [ 'RuleAction$SendNotificationAction' => 'Information about the send notification action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
The service quota has been exceeded.
', 'refs' => [], ], 'SignInConfig' => [ 'base' => 'The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
', 'refs' => [ 'GetTrafficDistributionResponse$SignInConfig' => 'The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
', 'UpdateTrafficDistributionRequest$SignInConfig' => 'The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
', ], ], 'SignInDistribution' => [ 'base' => 'The distribution of sign in traffic between the instance and its replica(s).
', 'refs' => [ 'SignInDistributionList$member' => NULL, ], ], 'SignInDistributionList' => [ 'base' => NULL, 'refs' => [ 'SignInConfig$Distributions' => 'Information about traffic distributions.
', ], ], 'SingleSelectOptions' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateField$SingleSelectOptions' => 'A list of options for a single select field.
', ], ], 'SingleSelectQuestionRuleCategoryAutomation' => [ 'base' => 'Information about the automation option based on a rule category for a single select question.
', 'refs' => [ 'EvaluationFormSingleSelectQuestionAutomationOption$RuleCategory' => 'The automation option based on a rule category for the single select question.
', ], ], 'SingleSelectQuestionRuleCategoryAutomationCondition' => [ 'base' => NULL, 'refs' => [ 'SingleSelectQuestionRuleCategoryAutomation$Condition' => 'The condition to apply for the automation option. If the condition is PRESENT
, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT
, then the option is applied when the contact data does not include the category.
The category name, as defined in Rules.
', ], ], 'SnapshotVersion' => [ 'base' => NULL, 'refs' => [ 'GetTaskTemplateRequest$SnapshotVersion' => 'The system generated version of a task template that is associated with a task, when the task is created.
', ], ], 'Sort' => [ 'base' => 'A structure that defineds the field name to sort by and a sort order.
', 'refs' => [ 'SearchContactsRequest$Sort' => 'Specifies a field to sort by and a sort order.
', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'CurrentMetricSortCriteria$SortOrder' => 'The way to sort.
', 'Sort$Order' => 'An ascending or descending sort.
', ], ], 'SortableFieldName' => [ 'base' => NULL, 'refs' => [ 'Sort$FieldName' => 'The name of the field on which to sort.
', ], ], 'SourceApplicationName' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationRequest$SourceApplicationName' => 'The name of the external application. This field is only required for the EVENT integration type.
', 'IntegrationAssociationSummary$SourceApplicationName' => 'The user-provided, friendly name for the external application.
', ], ], 'SourceId' => [ 'base' => NULL, 'refs' => [ 'SendChatIntegrationEventRequest$SourceId' => 'External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.
', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationRequest$SourceType' => 'The type of the data source. This field is only required for the EVENT integration type.
', 'IntegrationAssociationSummary$SourceType' => 'The name of the source.
', ], ], 'StartAttachedFileUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAttachedFileUploadResponse' => [ 'base' => 'Response from StartAttachedFileUpload API.', 'refs' => [], ], 'StartChatContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartChatContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartContactEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContactEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartContactRecordingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContactRecordingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartContactStreamingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContactStreamingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartOutboundVoiceContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartOutboundVoiceContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartWebRTCContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWebRTCContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'HistoricalMetric$Statistic' => 'The statistic for the metric.
', ], ], 'Step' => [ 'base' => 'Step signifies the criteria to be used for routing to an agent
', 'refs' => [ 'Steps$member' => NULL, ], ], 'Steps' => [ 'base' => NULL, 'refs' => [ 'RoutingCriteria$Steps' => 'List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
', ], ], 'StopContactRecordingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopContactRecordingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopContactStreamingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopContactStreamingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StorageType' => [ 'base' => NULL, 'refs' => [ 'InstanceStorageConfig$StorageType' => 'A valid storage type.
', ], ], 'StreamingId' => [ 'base' => NULL, 'refs' => [ 'StartContactStreamingResponse$StreamingId' => 'The identifier of the streaming configuration enabled.
', 'StopContactStreamingRequest$StreamingId' => 'The identifier of the streaming configuration enabled.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AnalyticsDataAssociationResult$ResourceShareId' => 'The Resource Access Manager share ID.
', 'AssociateAnalyticsDataSetResponse$ResourceShareId' => 'The Resource Access Manager share ID that is generated.
', 'ErrorResult$ErrorCode' => 'The error code.
', 'ErrorResult$ErrorMessage' => 'The corresponding error message for the error code.
', 'FailedRequest$FailureReasonMessage' => 'Why the request to create a contact failed.
', 'HierarchyGroupCondition$Value' => 'The value in the hierarchy group condition.
', 'InstanceStatusReason$Message' => 'The message.
', 'IntervalDetails$TimeZone' => 'The timezone applied to requested metrics.
', 'MetricFilterV2$MetricFilterKey' => 'The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD
, DISCONNECT_REASON
. These are the same values as the InitiationMethod
and DisconnectReason
in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator Guide.
The full property path.
', 'ResourceTypeList$member' => NULL, 'StringCondition$FieldName' => 'The name of the field in the string condition.
', 'StringCondition$Value' => 'The value of the string.
', 'TagCondition$TagKey' => 'The tag key in the tag condition.
', 'TagCondition$TagValue' => 'The tag value in the tag condition.
', 'UserTagMap$key' => NULL, 'UserTagMap$value' => NULL, ], ], 'StringComparisonType' => [ 'base' => NULL, 'refs' => [ 'StringCondition$ComparisonType' => 'The type of comparison to be made when evaluating the string condition.
', 'TagSearchCondition$tagKeyComparisonType' => 'The type of comparison to be made when evaluating the tag key in tag search condition.
', 'TagSearchCondition$tagValueComparisonType' => 'The type of comparison to be made when evaluating the tag value in tag search condition.
', ], ], 'StringCondition' => [ 'base' => 'A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
and description
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, timezone
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are associatedQueueIds
, name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are Username
, FirstName
, LastName
, RoutingProfileId
, SecurityProfileId
, ResourceId
.
Information about a reference when the referenceType
is STRING
. Otherwise, null.
Information about a reference when the referenceType
is STRING
. Otherwise, null.
The subject of the email if the delivery method is EMAIL
. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Information about the submit automated evaluation action.
', 'refs' => [ 'RuleAction$SubmitAutoEvaluationAction' => 'Information about the submit automated evaluation action.
', ], ], 'SubmitContactEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContactEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Subtype' => [ 'base' => NULL, 'refs' => [ 'SendChatIntegrationEventRequest$Subtype' => 'Classification of a channel. This is used in part to uniquely identify chat.
Valid value: ["connect:sms"]
Request for which contact was successfully created.
', 'refs' => [ 'SuccessfulRequestList$member' => NULL, ], ], 'SuccessfulRequestList' => [ 'base' => NULL, 'refs' => [ 'BatchPutContactResponse$SuccessfulRequestList' => 'List of requests for which contact was successfully created.
', ], ], 'SupportedMessagingContentType' => [ 'base' => NULL, 'refs' => [ 'SupportedMessagingContentTypes$member' => NULL, ], ], 'SupportedMessagingContentTypes' => [ 'base' => NULL, 'refs' => [ 'NewSessionDetails$SupportedMessagingContentTypes' => ' The supported chat message content types. Supported types are text/plain
, text/markdown
, application/json
, application/vnd.amazonaws.connect.message.interactive
, and application/vnd.amazonaws.connect.message.interactive.response
.
Content types must always contain text/plain
. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain
: [text/plain, text/markdown, application/json]
, [text/markdown, text/plain]
, [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]
.
The supported chat message content types. Supported types are text/plain
, text/markdown
, application/json
, application/vnd.amazonaws.connect.message.interactive
, and application/vnd.amazonaws.connect.message.interactive.response
.
Content types must always contain text/plain
. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain
: [text/plain, text/markdown, application/json]
, [text/markdown, text/plain]
, [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]
.
The type application/vnd.amazonaws.connect.message.interactive
is required to use the Show view flow block.
A leaf node condition which can be used to specify a tag condition.
', 'ControlPlaneTagFilter$AndConditions' => 'A list of conditions which would be applied together with an AND
condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123
.
A leaf node condition which can be used to specify a tag condition.
', 'ControlPlaneUserAttributeFilter$TagCondition' => NULL, 'TagAndConditionList$member' => NULL, ], ], 'TagContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, 'TagSet$key' => 'The tag key in the tagSet.
', ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The tag keys.
', ], ], 'TagKeyString' => [ 'base' => NULL, 'refs' => [ 'TagSearchCondition$tagKey' => 'The tag key used in the tag search condition.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'AttachedFile$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }
.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'ClaimedPhoneNumberSummary$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'ContactFlow$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'ContactFlowModule$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateAgentStatusRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateContactFlowModuleRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateContactFlowRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateHoursOfOperationRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateInstanceRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }
.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreatePromptRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateQueueRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateQuickConnectRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateRoutingProfileRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateSecurityProfileRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateTrafficDistributionGroupRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateUseCaseRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateUserHierarchyGroupRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateUserRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateViewRequest$Tags' => 'The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateVocabularyRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'Evaluation$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'EvaluationForm$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'GetAttachedFileResponse$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }
.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'HierarchyGroup$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'HoursOfOperation$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'ImportPhoneNumberRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'Instance$Tags' => 'The tags of an instance.
', 'ListTagsForResourceResponse$tags' => 'Information about the tags.
', 'Prompt$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'Queue$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'QuickConnect$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'RoutingProfile$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'Rule$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'SecurityProfile$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'SecurityProfileSearchSummary$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'StartAttachedFileUploadRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }
.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'TrafficDistributionGroup$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'User$Tags' => 'The tags.
', 'UserSearchSummary$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'View$Tags' => 'The tags associated with the view resource (not specific to view version).
', 'Vocabulary$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', ], ], 'TagOrConditionList' => [ 'base' => NULL, 'refs' => [ 'ControlPlaneTagFilter$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
| SecurityProfile
| Queue
| RoutingProfile
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
', 'UpdateSecurityProfileRequest$TagRestrictedResources' => 'The list of resources that a security profile applies tag restrictions to in Amazon Connect.
', ], ], 'TagRestrictedResourceName' => [ 'base' => NULL, 'refs' => [ 'TagRestrictedResourceList$member' => NULL, ], ], 'TagSearchCondition' => [ 'base' => 'The search criteria to be used to return tags.
', 'refs' => [ 'ResourceTagsSearchCriteria$TagSearchCondition' => 'The search criteria to be used to return tags.
', ], ], 'TagSet' => [ 'base' => 'A tag set contains tag key and tag value.
', 'refs' => [ 'TagsList$member' => NULL, ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, 'TagSet$value' => 'The tag value in the tagSet.
', ], ], 'TagValueString' => [ 'base' => NULL, 'refs' => [ 'TagSearchCondition$tagValue' => 'The tag value used in the tag search condition.
', ], ], 'TagsList' => [ 'base' => NULL, 'refs' => [ 'SearchResourceTagsResponse$Tags' => 'A list of tags used in the Amazon Connect instance.
', ], ], 'TaskActionDefinition' => [ 'base' => 'Information about the task action.
', 'refs' => [ 'RuleAction$TaskAction' => 'Information about the task action. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
', ], ], 'TaskNameExpression' => [ 'base' => NULL, 'refs' => [ 'TaskActionDefinition$Name' => 'The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
', ], ], 'TaskTemplateArn' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateResponse$Arn' => 'The Amazon Resource Name (ARN) for the task template resource.
', 'GetTaskTemplateResponse$Arn' => 'The Amazon Resource Name (ARN).
', 'TaskTemplateMetadata$Arn' => 'The Amazon Resource Name (ARN) of the task template.
', 'UpdateTaskTemplateResponse$Arn' => 'The Amazon Resource Name (ARN) for the task template resource.
', ], ], 'TaskTemplateConstraints' => [ 'base' => 'Describes constraints that apply to the template fields.
', 'refs' => [ 'CreateTaskTemplateRequest$Constraints' => 'Constraints that are applicable to the fields listed.
', 'GetTaskTemplateResponse$Constraints' => 'Constraints that are applicable to the fields listed.
', 'UpdateTaskTemplateRequest$Constraints' => 'Constraints that are applicable to the fields listed.
', 'UpdateTaskTemplateResponse$Constraints' => 'Constraints that are applicable to the fields listed.
', ], ], 'TaskTemplateDefaultFieldValue' => [ 'base' => 'Describes a default field and its corresponding value.
', 'refs' => [ 'TaskTemplateDefaultFieldValueList$member' => NULL, ], ], 'TaskTemplateDefaultFieldValueList' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateDefaults$DefaultFieldValues' => 'Default value for the field.
', ], ], 'TaskTemplateDefaults' => [ 'base' => 'Describes default values for fields on a template.
', 'refs' => [ 'CreateTaskTemplateRequest$Defaults' => 'The default values for fields when a task is created by referencing this template.
', 'GetTaskTemplateResponse$Defaults' => 'The default values for fields when a task is created by referencing this template.
', 'UpdateTaskTemplateRequest$Defaults' => 'The default values for fields when a task is created by referencing this template.
', 'UpdateTaskTemplateResponse$Defaults' => 'The default values for fields when a task is created by referencing this template.
', ], ], 'TaskTemplateDescription' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateRequest$Description' => 'The description of the task template.
', 'GetTaskTemplateResponse$Description' => 'The description of the task template.
', 'TaskTemplateMetadata$Description' => 'The description of the task template.
', 'UpdateTaskTemplateRequest$Description' => 'The description of the task template.
', 'UpdateTaskTemplateResponse$Description' => 'The description of the task template.
', ], ], 'TaskTemplateField' => [ 'base' => 'Describes a single task template field.
', 'refs' => [ 'TaskTemplateFields$member' => NULL, ], ], 'TaskTemplateFieldDescription' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateField$Description' => 'The description of the field.
', ], ], 'TaskTemplateFieldIdentifier' => [ 'base' => 'The identifier of the task template field.
', 'refs' => [ 'InvisibleFieldInfo$Id' => 'Identifier of the invisible field.
', 'ReadOnlyFieldInfo$Id' => 'Identifier of the read-only field.
', 'RequiredFieldInfo$Id' => 'The unique identifier for the field.
', 'TaskTemplateDefaultFieldValue$Id' => 'Identifier of a field.
', 'TaskTemplateField$Id' => 'The unique identifier for the field.
', ], ], 'TaskTemplateFieldName' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateFieldIdentifier$Name' => 'The name of the task template field.
', ], ], 'TaskTemplateFieldType' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateField$Type' => 'Indicates the type of field.
', ], ], 'TaskTemplateFieldValue' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateDefaultFieldValue$DefaultValue' => 'Default value for the field.
', ], ], 'TaskTemplateFields' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateRequest$Fields' => 'Fields that are part of the template.
', 'GetTaskTemplateResponse$Fields' => 'Fields that are part of the template.
', 'UpdateTaskTemplateRequest$Fields' => 'Fields that are part of the template.
', 'UpdateTaskTemplateResponse$Fields' => 'Fields that are part of the template.
', ], ], 'TaskTemplateId' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateResponse$Id' => 'The identifier of the task template resource.
', 'DeleteTaskTemplateRequest$TaskTemplateId' => 'A unique identifier for the task template.
', 'GetTaskTemplateRequest$TaskTemplateId' => 'A unique identifier for the task template.
', 'GetTaskTemplateResponse$Id' => 'A unique identifier for the task template.
', 'StartTaskContactRequest$TaskTemplateId' => 'A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
', 'TaskTemplateMetadata$Id' => 'A unique identifier for the task template.
', 'UpdateTaskTemplateRequest$TaskTemplateId' => 'A unique identifier for the task template.
', 'UpdateTaskTemplateResponse$Id' => 'The identifier of the task template resource.
', ], ], 'TaskTemplateList' => [ 'base' => NULL, 'refs' => [ 'ListTaskTemplatesResponse$TaskTemplates' => 'Provides details about a list of task templates belonging to an instance.
', ], ], 'TaskTemplateMetadata' => [ 'base' => 'Contains summary information about the task template.
', 'refs' => [ 'TaskTemplateList$member' => NULL, ], ], 'TaskTemplateName' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateRequest$Name' => 'The name of the task template.
', 'GetTaskTemplateResponse$Name' => 'The name of the task template.
', 'ListTaskTemplatesRequest$Name' => 'The name of the task template.
', 'TaskTemplateMetadata$Name' => 'The name of the task template.
', 'UpdateTaskTemplateRequest$Name' => 'The name of the task template.
', 'UpdateTaskTemplateResponse$Name' => 'The name of the task template.
', ], ], 'TaskTemplateSingleSelectOption' => [ 'base' => NULL, 'refs' => [ 'SingleSelectOptions$member' => NULL, ], ], 'TaskTemplateStatus' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateRequest$Status' => 'Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The distribution of traffic between the instance and its replicas.
', 'refs' => [ 'GetTrafficDistributionResponse$TelephonyConfig' => 'The distribution of traffic between the instance and its replicas.
', 'UpdateTrafficDistributionRequest$TelephonyConfig' => 'The distribution of traffic between the instance and its replica(s).
', ], ], 'TemplateId' => [ 'base' => NULL, 'refs' => [ 'CreateCaseActionDefinition$TemplateId' => 'A unique identifier of a template.
', ], ], 'Threshold' => [ 'base' => 'Contains information about the threshold for service level metrics.
', 'refs' => [ 'HistoricalMetric$Threshold' => 'The threshold for the metric, used with service level metrics.
', ], ], 'ThresholdCollections' => [ 'base' => NULL, 'refs' => [ 'MetricV2$Threshold' => 'Contains information about the threshold for service level metrics.
', ], ], 'ThresholdV2' => [ 'base' => 'Contains information about the threshold for service level metrics.
', 'refs' => [ 'ThresholdCollections$member' => NULL, ], ], 'ThresholdValue' => [ 'base' => NULL, 'refs' => [ 'Threshold$ThresholdValue' => 'The threshold value to compare.
', 'ThresholdV2$ThresholdValue' => 'The threshold value to compare.
', ], ], 'ThrottlingException' => [ 'base' => 'The throttling limit has been exceeded.
', 'refs' => [], ], 'TimeZone' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationRequest$TimeZone' => 'The time zone of the hours of operation.
', 'HoursOfOperation$TimeZone' => 'The time zone for the hours of operation.
', 'UpdateHoursOfOperationRequest$TimeZone' => 'The time zone of the hours of operation.
', ], ], 'TimerEligibleParticipantRoles' => [ 'base' => NULL, 'refs' => [ 'ParticipantTimerConfiguration$ParticipantRole' => 'The role of the participant in the chat conversation.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$StateStartTimestamp' => 'The epoch timestamp when the contact state started.
', 'AgentContactReference$ConnectedToAgentTimestamp' => 'The time at which the contact was connected to an agent.
', 'AgentStatus$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'AgentStatusReference$StatusStartTimestamp' => 'The start timestamp of the agent\'s status.
', 'AgentStatusSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'Evaluation$CreatedTime' => 'The timestamp for when the evaluation was created.
', 'Evaluation$LastModifiedTime' => 'The timestamp for when the evaluation was last updated.
', 'EvaluationForm$CreatedTime' => 'The timestamp for when the evaluation form was created.
', 'EvaluationForm$LastModifiedTime' => 'The timestamp for when the evaluation form was last updated.
', 'EvaluationFormSummary$CreatedTime' => 'The timestamp for when the evaluation form was created.
', 'EvaluationFormSummary$LastModifiedTime' => 'The timestamp for when the evaluation form was last updated.
', 'EvaluationFormSummary$LastActivatedTime' => 'The timestamp for when the evaluation form was last activated.
', 'EvaluationFormVersionSummary$CreatedTime' => 'The timestamp for when the evaluation form was created.
', 'EvaluationFormVersionSummary$LastModifiedTime' => 'The timestamp for when the evaluation form was last updated.
', 'EvaluationSummary$CreatedTime' => 'The timestamp for when the evaluation was created.
', 'EvaluationSummary$LastModifiedTime' => 'The timestamp for when the evaluation was last updated.
', 'GetMetricDataV2Request$StartTime' => 'The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be before the end time timestamp. The start and end time depends on the IntervalPeriod
selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be later than the start time timestamp. It cannot be later than the current timestamp.
', 'GetPromptFileResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HierarchyGroup$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HierarchyGroupSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HierarchyLevel$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HoursOfOperation$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HoursOfOperationSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'Instance$CreatedTime' => 'When the instance was created.
', 'InstanceSummary$CreatedTime' => 'When the instance was created.
', 'ListQueueQuickConnectsResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'ListRoutingProfileQueuesResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'ListSecurityProfileApplicationsResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'ListSecurityProfilePermissionsResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'ListUserProficienciesResponse$LastModifiedTime' => 'The last time that the user\'s proficiencies are were modified.
', 'MetricInterval$StartTime' => 'The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected.
', 'MetricInterval$EndTime' => 'The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If IntervalPeriod
is selected THIRTY_MIN
, StartTime
and EndTime
in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each StartTime
and EndTime
differing by 30 minutes.
Last modified time.
', 'PredefinedAttributeSummary$LastModifiedTime' => 'Last modified time.
', 'Prompt$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'PromptSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'Queue$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'QueueSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'QuickConnect$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'QuickConnectSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'RoutingProfile$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'RoutingProfileSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'Rule$CreatedTime' => 'The timestamp for when the rule was created.
', 'Rule$LastUpdatedTime' => 'The timestamp for the when the rule was last updated.
', 'RuleSummary$CreatedTime' => 'The timestamp for when the rule was created.
', 'RuleSummary$LastUpdatedTime' => 'The timestamp for when the rule was last updated.
', 'SearchContactsTimeRange$StartTime' => 'The start time of the time range.
', 'SearchContactsTimeRange$EndTime' => 'The end time of the time range.
', 'SecurityProfile$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'SecurityProfileSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'StartTaskContactRequest$ScheduledTime' => 'The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
', 'UpdateContactScheduleRequest$ScheduledTime' => 'The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
', 'User$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'UserSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'View$CreatedTime' => 'The timestamp of when the view was created.
', 'View$LastModifiedTime' => 'Latest timestamp of the UpdateViewContent
or CreateViewVersion
operations.
Displayed when rate-related API limits are exceeded.
', 'refs' => [], ], 'TotalCount' => [ 'base' => NULL, 'refs' => [ 'SearchContactsResponse$TotalCount' => 'The total number of contacts which matched your search query.
', ], ], 'TotalPauseCount' => [ 'base' => NULL, 'refs' => [ 'Contact$TotalPauseCount' => 'Total pause count for a contact.
', ], ], 'TotalPauseDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Contact$TotalPauseDurationInSeconds' => 'Total pause duration for a contact in seconds.
', ], ], 'TrafficDistributionGroup' => [ 'base' => 'Information about a traffic distribution group.
', 'refs' => [ 'DescribeTrafficDistributionGroupResponse$TrafficDistributionGroup' => 'Information about the traffic distribution group.
', ], ], 'TrafficDistributionGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupResponse$Arn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', 'GetTrafficDistributionResponse$Arn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', 'TrafficDistributionGroup$Arn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', 'TrafficDistributionGroupSummary$Arn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', ], ], 'TrafficDistributionGroupId' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupResponse$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'GetTrafficDistributionResponse$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'TrafficDistributionGroup$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'TrafficDistributionGroupSummary$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', ], ], 'TrafficDistributionGroupIdOrArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrafficDistributionGroupUserRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'DeleteTrafficDistributionGroupRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'DescribeTrafficDistributionGroupRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'DisassociateTrafficDistributionGroupUserRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'GetTrafficDistributionRequest$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'ListTrafficDistributionGroupUsersRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'UpdateTrafficDistributionRequest$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', ], ], 'TrafficDistributionGroupStatus' => [ 'base' => NULL, 'refs' => [ 'TrafficDistributionGroup$Status' => 'The status of the traffic distribution group.
CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistribution operation is still in progress and has not yet completed.
The status of the traffic distribution group.
CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
Information about traffic distribution groups.
', 'refs' => [ 'TrafficDistributionGroupSummaryList$member' => NULL, ], ], 'TrafficDistributionGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListTrafficDistributionGroupsResponse$TrafficDistributionGroupSummaryList' => 'A list of traffic distribution groups.
', ], ], 'TrafficDistributionGroupUserSummary' => [ 'base' => 'Summary information about a traffic distribution group user.
', 'refs' => [ 'TrafficDistributionGroupUserSummaryList$member' => NULL, ], ], 'TrafficDistributionGroupUserSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListTrafficDistributionGroupUsersResponse$TrafficDistributionGroupUserSummaryList' => 'A list of traffic distribution group users.
', ], ], 'TrafficType' => [ 'base' => NULL, 'refs' => [ 'StartOutboundVoiceContactRequest$TrafficType' => 'Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL
. Use CAMPAIGN
if EnableAnswerMachineDetection
is set to true
. For all other cases, use GENERAL
.
A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.
', 'refs' => [ 'ContactAnalysis$Transcript' => 'Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
', ], ], 'TranscriptCriteria' => [ 'base' => 'A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
', 'refs' => [ 'TranscriptCriteriaList$member' => NULL, ], ], 'TranscriptCriteriaList' => [ 'base' => NULL, 'refs' => [ 'Transcript$Criteria' => 'The list of search criteria based on Contact Lens conversational analytics transcript.
', ], ], 'TransferContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'TransferContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationRequest$SourceApplicationUrl' => 'The URL for the external application. This field is only required for the EVENT integration type.
', 'IntegrationAssociationSummary$SourceApplicationUrl' => 'The URL for the external application.
', 'MediaPlacement$AudioHostUrl' => 'The audio host URL.
', 'MediaPlacement$AudioFallbackUrl' => 'The audio fallback URL.
', 'MediaPlacement$SignalingUrl' => 'The signaling URL.
', 'MediaPlacement$TurnControlUrl' => 'The turn control URL.
', 'MediaPlacement$EventIngestionUrl' => 'The event ingestion URL to which you send client meeting events.
', ], ], 'URLExpiryInSeconds' => [ 'base' => NULL, 'refs' => [ 'GetAttachedFileRequest$UrlExpiryInSeconds' => 'Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
', 'StartAttachedFileUploadRequest$UrlExpiryInSeconds' => 'Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
', ], ], 'Unit' => [ 'base' => NULL, 'refs' => [ 'CurrentMetric$Unit' => 'The unit for the metric.
', 'HistoricalMetric$Unit' => 'The unit for the metric.
', ], ], 'UntagContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentStatusDescription' => [ 'base' => NULL, 'refs' => [ 'UpdateAgentStatusRequest$Description' => 'The description of the agent status.
', ], ], 'UpdateAgentStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCaseActionDefinition' => [ 'base' => 'The UpdateCase
action definition.
Information about the update case action.
Supported only for TriggerEventSource
values: OnCaseCreate
| OnCaseUpdate
.
The description of the hours of operation.
', ], ], 'UpdateHoursOfOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceStorageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateParticipantRoleConfigChannelInfo' => [ 'base' => 'Configuration information for the chat participant role.
', 'refs' => [ 'UpdateParticipantRoleConfigRequest$ChannelConfiguration' => 'The Amazon Connect channel you want to configure.
', ], ], 'UpdateParticipantRoleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateParticipantRoleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePredefinedAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePromptRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePromptResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueHoursOfOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueMaxContactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueNameRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueOutboundCallerConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQuickConnectConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQuickConnectDescription' => [ 'base' => NULL, 'refs' => [ 'UpdateQuickConnectNameRequest$Description' => 'The description of the quick connect.
', ], ], 'UpdateQuickConnectNameRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileAgentAvailabilityTimerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileConcurrencyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileDefaultOutboundQueueRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileNameRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecurityProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrafficDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrafficDistributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserHierarchyGroupNameRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserHierarchyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserHierarchyStructureRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserIdentityInfoRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserPhoneConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProficienciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRoutingProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserSecurityProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateViewContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateViewContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateViewMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateViewMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'UploadUrlMetadata' => [ 'base' => 'Fields required when uploading an attached file.
', 'refs' => [ 'StartAttachedFileUploadResponse$UploadUrlMetadata' => 'Information to be used while uploading the attached file.
', ], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'GetFederationTokenResponse$SignInUrl' => 'The URL to sign into the user\'s instance.
', 'Instance$InstanceAccessUrl' => 'This URL allows contact center users to access the Amazon Connect admin website.
', 'InstanceSummary$InstanceAccessUrl' => 'This URL allows contact center users to access the Amazon Connect admin website.
', ], ], 'UrlMetadataSignedHeaders' => [ 'base' => NULL, 'refs' => [ 'UploadUrlMetadata$HeadersToInclude' => 'A map of headers that should be provided when uploading the attached file.
', ], ], 'UrlMetadataSignedHeadersKey' => [ 'base' => NULL, 'refs' => [ 'UrlMetadataSignedHeaders$key' => NULL, ], ], 'UrlMetadataSignedHeadersValue' => [ 'base' => NULL, 'refs' => [ 'UrlMetadataSignedHeaders$value' => NULL, ], ], 'UrlReference' => [ 'base' => 'The URL reference.
', 'refs' => [ 'ReferenceSummary$Url' => 'Information about the reference when the referenceType
is URL
. Otherwise, null.
Contains the use case.
', 'refs' => [ 'UseCaseSummaryList$member' => NULL, ], ], 'UseCaseId' => [ 'base' => NULL, 'refs' => [ 'CreateUseCaseResponse$UseCaseId' => 'The identifier of the use case.
', 'DeleteUseCaseRequest$UseCaseId' => 'The identifier for the use case.
', 'UseCase$UseCaseId' => 'The identifier for the use case.
', ], ], 'UseCaseSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListUseCasesResponse$UseCaseSummaryList' => 'The use cases.
', ], ], 'UseCaseType' => [ 'base' => NULL, 'refs' => [ 'CreateUseCaseRequest$UseCaseType' => 'The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
', 'UseCase$UseCaseType' => 'The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
', ], ], 'User' => [ 'base' => 'Contains information about a user account for an Amazon Connect instance.
', 'refs' => [ 'DescribeUserResponse$User' => 'Information about the user account and configuration settings.
', ], ], 'UserData' => [ 'base' => 'Data for a user.
', 'refs' => [ 'UserDataList$member' => NULL, ], ], 'UserDataFilters' => [ 'base' => 'A filter for the user data.
', 'refs' => [ 'GetCurrentUserDataRequest$Filters' => 'The filters to apply to returned user data. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1
The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
Currently tagging is only supported on the resources that are passed in the filter.
', ], ], 'UserDataHierarchyGroups' => [ 'base' => NULL, 'refs' => [ 'UserDataFilters$UserHierarchyGroups' => 'A UserHierarchyGroup ID or ARN.
', ], ], 'UserDataList' => [ 'base' => NULL, 'refs' => [ 'GetCurrentUserDataResponse$UserDataList' => 'A list of the user data that is returned.
', ], ], 'UserId' => [ 'base' => NULL, 'refs' => [ 'AgentsMinOneMaxHundred$member' => NULL, 'AssociateTrafficDistributionGroupUserRequest$UserId' => 'The identifier of the user account. This can be the ID or the ARN of the user.
', 'AssociateUserProficienciesRequest$UserId' => 'The identifier of the user account.
', 'CreateUserResponse$UserId' => 'The identifier of the user account.
', 'DeleteUserRequest$UserId' => 'The identifier of the user.
', 'DescribeUserRequest$UserId' => 'The identifier of the user account.
', 'DisassociateTrafficDistributionGroupUserRequest$UserId' => 'The identifier for the user. This can be the ID or the ARN of the user.
', 'DisassociateUserProficienciesRequest$UserId' => 'The identifier of the user account.
', 'DismissUserContactRequest$UserId' => 'The identifier of the user account.
', 'ListUserProficienciesRequest$UserId' => 'The identifier of the user account.
', 'PutUserStatusRequest$UserId' => 'The identifier of the user.
', 'TrafficDistributionGroupUserSummary$UserId' => 'The identifier for the user. This can be the ID or the ARN of the user.
', 'UpdateUserHierarchyRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserIdentityInfoRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserPhoneConfigRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserProficienciesRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserRoutingProfileRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserSecurityProfilesRequest$UserId' => 'The identifier of the user account.
', 'User$Id' => 'The identifier of the user account.
', 'UserIdList$member' => NULL, 'UserQuickConnectConfig$UserId' => 'The identifier of the user.
', 'UserReference$Id' => 'The unique identifier for the user.
', 'UserSearchSummary$Id' => 'The identifier of the user\'s summary.
', 'UserSummary$Id' => 'The identifier of the user account.
', ], ], 'UserIdList' => [ 'base' => NULL, 'refs' => [ 'NotificationRecipientType$UserIds' => 'A list of user IDs.
', ], ], 'UserIdentityInfo' => [ 'base' => 'Contains information about the identity of a user.
For Amazon Connect instances that are created with the EXISTING_DIRECTORY
identity management type, FirstName
, LastName
, and Email
cannot be updated from within Amazon Connect because they are managed by the directory.
The information about the identity of the user.
', 'UpdateUserIdentityInfoRequest$IdentityInfo' => 'The identity information for the user.
', 'User$IdentityInfo' => 'Information about the user identity.
', ], ], 'UserIdentityInfoLite' => [ 'base' => 'The user\'s first name and last name.
', 'refs' => [ 'UserSearchSummary$IdentityInfo' => 'The user\'s first name and last name.
', ], ], 'UserNotFoundException' => [ 'base' => 'No user with the specified credentials was found in the Amazon Connect instance.
', 'refs' => [], ], 'UserPhoneConfig' => [ 'base' => 'Contains information about the phone configuration settings for a user.
', 'refs' => [ 'CreateUserRequest$PhoneConfig' => 'The phone settings for the user.
', 'UpdateUserPhoneConfigRequest$PhoneConfig' => 'Information about phone configuration settings for the user.
', 'User$PhoneConfig' => 'Information about the phone configuration for the user.
', 'UserSearchSummary$PhoneConfig' => NULL, ], ], 'UserProficiency' => [ 'base' => 'Information about proficiency of a user.
', 'refs' => [ 'UserProficiencyList$member' => NULL, ], ], 'UserProficiencyDisassociate' => [ 'base' => 'Information about proficiency to be disassociated from the user.
', 'refs' => [ 'UserProficiencyDisassociateList$member' => NULL, ], ], 'UserProficiencyDisassociateList' => [ 'base' => NULL, 'refs' => [ 'DisassociateUserProficienciesRequest$UserProficiencies' => 'The proficiencies to disassociate from the user.
', ], ], 'UserProficiencyList' => [ 'base' => NULL, 'refs' => [ 'AssociateUserProficienciesRequest$UserProficiencies' => 'The proficiencies to associate with the user.
', 'ListUserProficienciesResponse$UserProficiencyList' => 'Information about the user proficiencies.
', 'UpdateUserProficienciesRequest$UserProficiencies' => 'The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.
', ], ], 'UserQuickConnectConfig' => [ 'base' => 'Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
', 'refs' => [ 'QuickConnectConfig$UserConfig' => 'The user configuration. This is required only if QuickConnectType is USER.
', ], ], 'UserReference' => [ 'base' => 'Information about the user.
', 'refs' => [ 'UserData$User' => 'Information about the user for the data that is returned. It contains the resourceId
and ARN of the user.
A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return users.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
', 'refs' => [ 'SearchUsersRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'UserSearchSummary' => [ 'base' => 'Information about the returned users.
', 'refs' => [ 'UserSearchSummaryList$member' => NULL, ], ], 'UserSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchUsersResponse$Users' => 'Information about the users.
', ], ], 'UserSummary' => [ 'base' => 'Contains summary information about a user.
', 'refs' => [ 'UserSummaryList$member' => NULL, ], ], 'UserSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$UserSummaryList' => 'Information about the users.
', ], ], 'UserTagMap' => [ 'base' => NULL, 'refs' => [ 'NotificationRecipientType$UserTags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.
', ], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'CurrentMetricData$Value' => 'The value of the metric.
', 'HistoricalMetricData$Value' => 'The value of the metric.
', 'MetricDataV2$Value' => 'The corresponding value of the metric returned in the response.
', ], ], 'VersionNumber' => [ 'base' => NULL, 'refs' => [ 'ActivateEvaluationFormRequest$EvaluationFormVersion' => 'The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.
', 'ActivateEvaluationFormResponse$EvaluationFormVersion' => 'A version of the evaluation form.
', 'DeactivateEvaluationFormRequest$EvaluationFormVersion' => 'A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.
', 'DeactivateEvaluationFormResponse$EvaluationFormVersion' => 'The version of the deactivated evaluation form resource.
', 'DeleteEvaluationFormRequest$EvaluationFormVersion' => 'The unique identifier for the evaluation form.
', 'DescribeEvaluationFormRequest$EvaluationFormVersion' => 'A version of the evaluation form.
', 'EvaluationForm$EvaluationFormVersion' => 'A version of the evaluation form.
', 'EvaluationFormContent$EvaluationFormVersion' => 'A version of the evaluation form.
', 'EvaluationFormSummary$LatestVersion' => 'The version number of the latest evaluation form version.
', 'EvaluationFormSummary$ActiveVersion' => 'The version of the active evaluation form version.
', 'EvaluationFormVersionSummary$EvaluationFormVersion' => 'A version of the evaluation form.
', 'UpdateEvaluationFormRequest$EvaluationFormVersion' => 'A version of the evaluation form to update.
', 'UpdateEvaluationFormResponse$EvaluationFormVersion' => 'The version of the updated evaluation form resource.
', ], ], 'VideoCapability' => [ 'base' => NULL, 'refs' => [ 'ParticipantCapabilities$Video' => 'The configuration having the video sharing capabilities for participants over the call.
', ], ], 'View' => [ 'base' => 'A view resource object. Contains metadata and content necessary to render the view.
', 'refs' => [ 'CreateViewResponse$View' => 'A view resource object. Contains metadata and content necessary to render the view.
', 'CreateViewVersionResponse$View' => 'All view data is contained within the View object.
', 'DescribeViewResponse$View' => 'All view data is contained within the View object.
', 'UpdateViewContentResponse$View' => 'A view resource object. Contains metadata and content necessary to render the view.
', ], ], 'ViewAction' => [ 'base' => NULL, 'refs' => [ 'ViewActions$member' => NULL, ], ], 'ViewActions' => [ 'base' => NULL, 'refs' => [ 'ViewContent$Actions' => 'A list of possible actions from the view.
', 'ViewInputContent$Actions' => 'A list of possible actions from the view.
', ], ], 'ViewContent' => [ 'base' => 'View content containing all content necessary to render a view except for runtime input data.
', 'refs' => [ 'View$Content' => 'View content containing all content necessary to render a view except for runtime input data.
', ], ], 'ViewContentSha256' => [ 'base' => NULL, 'refs' => [ 'CreateViewVersionRequest$ViewContentSha256' => 'Indicates the checksum value of the latest published view content.
', 'View$ViewContentSha256' => 'Indicates the checksum value of the latest published view content.
', ], ], 'ViewDescription' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$Description' => 'The description of the view.
', 'CreateViewVersionRequest$VersionDescription' => 'The description for the version being published.
', 'UpdateViewMetadataRequest$Description' => 'The description of the view.
', 'View$Description' => 'The description of the view.
', 'View$VersionDescription' => 'The description of the version.
', 'ViewSummary$Description' => 'The description of the view.
', 'ViewVersionSummary$Description' => 'The description of the view version.
', 'ViewVersionSummary$VersionDescription' => 'The description of the view version.
', ], ], 'ViewId' => [ 'base' => NULL, 'refs' => [ 'CreateViewVersionRequest$ViewId' => 'The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view. Both ViewArn
and ViewId
can be used.
The ViewId of the view. This must be an ARN for Amazon Web Services managed views.
', 'ListViewVersionsRequest$ViewId' => 'The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view.
', 'ViewSummary$Id' => 'The identifier of the view.
', 'ViewVersionSummary$Id' => 'The identifier of the view version.
', ], ], 'ViewInputContent' => [ 'base' => 'View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
', 'refs' => [ 'CreateViewRequest$Content' => 'View content containing all content necessary to render a view except for runtime input data.
The total uncompressed content has a maximum file size of 400kB.
', 'UpdateViewContentRequest$Content' => 'View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
The total uncompressed content has a maximum file size of 400kB.
', ], ], 'ViewInputSchema' => [ 'base' => NULL, 'refs' => [ 'ViewContent$InputSchema' => 'The data schema matching data that the view template must be provided to render.
', ], ], 'ViewName' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$Name' => 'The name of the view.
', 'UpdateViewMetadataRequest$Name' => 'The name of the view.
', 'View$Name' => 'The name of the view.
', 'ViewSummary$Name' => 'The name of the view.
', 'ViewVersionSummary$Name' => 'The name of the view version.
', ], ], 'ViewStatus' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$Status' => 'Indicates the view status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content.
Indicates the view status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content.
Indicates the view status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content.
Indicates the view status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content.
A summary of a view\'s metadata.
', 'refs' => [ 'ViewsSummaryList$member' => NULL, ], ], 'ViewTemplate' => [ 'base' => NULL, 'refs' => [ 'ViewContent$Template' => 'The view template representing the structure of the view.
', 'ViewInputContent$Template' => 'The view template representing the structure of the view.
', ], ], 'ViewType' => [ 'base' => NULL, 'refs' => [ 'ListViewsRequest$Type' => 'The type of the view.
', 'View$Type' => 'The type of the view - CUSTOMER_MANAGED
.
The type of the view.
', 'ViewVersionSummary$Type' => 'The type of the view version.
', ], ], 'ViewVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteViewVersionRequest$ViewVersion' => 'The version number of the view.
', 'View$Version' => 'Current version of the view.
', 'ViewVersionSummary$Version' => 'The sequentially incremented version of the view version.
', ], ], 'ViewVersionSummary' => [ 'base' => 'A summary of a view version\'s metadata.
', 'refs' => [ 'ViewVersionSummaryList$member' => NULL, ], ], 'ViewVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListViewVersionsResponse$ViewVersionSummaryList' => 'A list of view version summaries.
', ], ], 'ViewsClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$ClientToken' => 'A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.
', ], ], 'ViewsInstanceId' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'CreateViewVersionRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'DeleteViewRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'DeleteViewVersionRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'DescribeViewRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'ListViewVersionsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'ListViewsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'UpdateViewContentRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'UpdateViewMetadataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', ], ], 'ViewsNextToken' => [ 'base' => NULL, 'refs' => [ 'ListViewVersionsRequest$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.
', 'ListViewVersionsResponse$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.
', 'ListViewsRequest$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.
', 'ListViewsResponse$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.
', ], ], 'ViewsSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListViewsResponse$ViewsSummaryList' => 'A list of view summaries.
', ], ], 'Vocabulary' => [ 'base' => 'Contains information about a custom vocabulary.
', 'refs' => [ 'DescribeVocabularyResponse$Vocabulary' => 'A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.
', ], ], 'VocabularyContent' => [ 'base' => NULL, 'refs' => [ 'CreateVocabularyRequest$Content' => 'The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase
, IPA
, SoundsLike
, and DisplayAs
fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase
, IPA
, SoundsLike
, and DisplayAs
fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
The reason why the custom vocabulary was not created.
', 'VocabularySummary$FailureReason' => 'The reason why the custom vocabulary was not created.
', ], ], 'VocabularyId' => [ 'base' => NULL, 'refs' => [ 'AssociateDefaultVocabularyRequest$VocabularyId' => 'The identifier of the custom vocabulary. If this is empty, the default is set to none.
', 'CreateVocabularyResponse$VocabularyId' => 'The identifier of the custom vocabulary.
', 'DefaultVocabulary$VocabularyId' => 'The identifier of the custom vocabulary.
', 'DeleteVocabularyRequest$VocabularyId' => 'The identifier of the custom vocabulary.
', 'DeleteVocabularyResponse$VocabularyId' => 'The identifier of the custom vocabulary.
', 'DescribeVocabularyRequest$VocabularyId' => 'The identifier of the custom vocabulary.
', 'Vocabulary$Id' => 'The identifier of the custom vocabulary.
', 'VocabularySummary$Id' => 'The identifier of the custom vocabulary.
', ], ], 'VocabularyLanguageCode' => [ 'base' => NULL, 'refs' => [ 'AssociateDefaultVocabularyRequest$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'CreateVocabularyRequest$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'DefaultVocabulary$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'ListDefaultVocabulariesRequest$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'SearchVocabulariesRequest$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'Vocabulary$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'VocabularySummary$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', ], ], 'VocabularyLastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'Vocabulary$LastModifiedTime' => 'The timestamp when the custom vocabulary was last modified.
', 'VocabularySummary$LastModifiedTime' => 'The timestamp when the custom vocabulary was last modified.
', ], ], 'VocabularyName' => [ 'base' => NULL, 'refs' => [ 'CreateVocabularyRequest$VocabularyName' => 'A unique name of the custom vocabulary.
', 'DefaultVocabulary$VocabularyName' => 'A unique name of the custom vocabulary.
', 'SearchVocabulariesRequest$NameStartsWith' => 'The starting pattern of the name of the vocabulary.
', 'Vocabulary$Name' => 'A unique name of the custom vocabulary.
', 'VocabularySummary$Name' => 'A unique name of the custom vocabulary.
', ], ], 'VocabularyNextToken' => [ 'base' => NULL, 'refs' => [ 'ListDefaultVocabulariesRequest$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.
', 'ListDefaultVocabulariesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchVocabulariesRequest$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.
', 'SearchVocabulariesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'VocabularyState' => [ 'base' => NULL, 'refs' => [ 'CreateVocabularyResponse$State' => 'The current state of the custom vocabulary.
', 'DeleteVocabularyResponse$State' => 'The current state of the custom vocabulary.
', 'SearchVocabulariesRequest$State' => 'The current state of the custom vocabulary.
', 'Vocabulary$State' => 'The current state of the custom vocabulary.
', 'VocabularySummary$State' => 'The current state of the custom vocabulary.
', ], ], 'VocabularySummary' => [ 'base' => 'Contains summary information about the custom vocabulary.
', 'refs' => [ 'VocabularySummaryList$member' => NULL, ], ], 'VocabularySummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchVocabulariesResponse$VocabularySummaryList' => 'The list of the available custom vocabularies.
', ], ], 'VoiceRecordingConfiguration' => [ 'base' => 'Contains information about the recording configuration settings.
', 'refs' => [ 'StartContactRecordingRequest$VoiceRecordingConfiguration' => 'The person being recorded.
', ], ], 'VoiceRecordingTrack' => [ 'base' => NULL, 'refs' => [ 'VoiceRecordingConfiguration$VoiceRecordingTrack' => 'Identifies which track is being recorded.
', ], ], 'WisdomInfo' => [ 'base' => 'Information about Amazon Connect Wisdom.
', 'refs' => [ 'Contact$WisdomInfo' => 'Information about Amazon Connect Wisdom.
', ], ], 'resourceArnListMaxLimit100' => [ 'base' => NULL, 'refs' => [ 'BatchGetFlowAssociationRequest$ResourceIds' => 'A list of resource identifiers to retrieve flow associations.
', ], ], 'timestamp' => [ 'base' => NULL, 'refs' => [ 'AgentInfo$ConnectedToAgentTimestamp' => 'The timestamp when the contact was connected to the agent.
', 'Contact$InitiationTimestamp' => 'The date and time this contact was initiated, in UTC time. For INBOUND
, this is when the contact arrived. For OUTBOUND
, this is when the agent began dialing. For CALLBACK
, this is when the callback contact was created. For TRANSFER
and QUEUE_TRANSFER
, this is when the transfer was initiated. For API
, this is when the request arrived. For EXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. For MONITOR
, this is when the supervisor started listening to a contact.
The timestamp when the customer endpoint disconnected from Amazon Connect.
', 'Contact$LastUpdateTimestamp' => 'The timestamp when contact was last updated.
', 'Contact$LastPausedTimestamp' => 'The timestamp when the contact was last paused.
', 'Contact$LastResumedTimestamp' => 'The timestamp when the contact was last resumed.
', 'Contact$ScheduledTimestamp' => 'The timestamp, in Unix epoch time format, at which to start running the inbound flow.
', 'Contact$ConnectedToSystemTimestamp' => 'The timestamp when customer endpoint connected to Amazon Connect.
', 'ContactSearchSummary$InitiationTimestamp' => 'The date and time this contact was initiated, in UTC time. For INBOUND
, this is when the contact arrived. For OUTBOUND
, this is when the agent began dialing. For CALLBACK
, this is when the callback contact was created. For TRANSFER
and QUEUE_TRANSFER
, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. For MONITOR
, this is when the supervisor started listening to a contact.
The timestamp when the customer endpoint disconnected from Amazon Connect.
', 'ContactSearchSummary$ScheduledTimestamp' => 'The timestamp, in Unix epoch time format, at which to start running the inbound flow.
', 'ContactSearchSummaryAgentInfo$ConnectedToAgentTimestamp' => 'The timestamp when the contact was connected to the agent.
', 'ContactSearchSummaryQueueInfo$EnqueueTimestamp' => 'The timestamp when the contact was added to the queue.
', 'Credentials$AccessTokenExpiration' => 'A token generated with an expiration time for the session a user is logged in to Amazon Connect.
', 'Credentials$RefreshTokenExpiration' => 'Renews the expiration timer for a generated token.
', 'CustomerVoiceActivity$GreetingStartTimestamp' => 'Timestamp that measures the beginning of the customer greeting from an outbound voice call.
', 'CustomerVoiceActivity$GreetingEndTimestamp' => 'Timestamp that measures the end of the customer greeting from an outbound voice call.
', 'Expiry$ExpiryTimestamp' => 'The timestamp indicating when the routing step expires.
', 'GetCurrentMetricDataResponse$DataSnapshotTime' => 'The time at which the metrics were retrieved and cached for pagination.
', 'GetMetricDataRequest$StartTime' => 'The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
', 'GetMetricDataRequest$EndTime' => 'The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
', 'GetTaskTemplateResponse$LastModifiedTime' => 'The timestamp when the task template was last modified.
', 'GetTaskTemplateResponse$CreatedTime' => 'The timestamp when the task template was created.
', 'QueueInfo$EnqueueTimestamp' => 'The timestamp when the contact was added to the queue.
', 'RoutingCriteria$ActivationTimestamp' => 'The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
', 'SecurityKey$CreationTime' => 'When the security key was created.
', 'TaskTemplateMetadata$LastModifiedTime' => 'The timestamp when the task template was last modified.
', 'TaskTemplateMetadata$CreatedTime' => 'The timestamp when the task template was created.
', 'UpdateTaskTemplateResponse$LastModifiedTime' => 'The timestamp when the task template was last modified.
', 'UpdateTaskTemplateResponse$CreatedTime' => 'The timestamp when the task template was created.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
', 'operations' => [ 'ActivateEvaluationForm' => 'Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
', 'AssociateAnalyticsDataSet' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
', 'AssociateApprovedOrigin' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
', 'AssociateBot' => 'This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
', 'AssociateDefaultVocabulary' => 'Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
', 'AssociateFlow' => 'Associates a connect resource to a flow.
', 'AssociateInstanceStorageConfig' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can\'t define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn\'t exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
', 'AssociateLambdaFunction' => 'This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
', 'AssociateLexBot' => 'This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
', 'AssociatePhoneNumberContactFlow' => 'Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
', 'AssociateRoutingProfileQueues' => 'Associates a set of queues with a routing profile.
', 'AssociateSecurityKey' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
', 'AssociateTrafficDistributionGroupUser' => 'Associates an agent with a traffic distribution group.
', 'AssociateUserProficiencies' => '>Associates a set of proficiencies with a user.
', 'BatchAssociateAnalyticsDataSet' => 'This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
', 'BatchDisassociateAnalyticsDataSet' => 'This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
', 'BatchGetAttachedFileMetadata' => 'Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
', 'BatchGetFlowAssociation' => 'Retrieve the flow associations for the given resources.
', 'BatchPutContact' => 'Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
', 'ClaimPhoneNumber' => 'Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
', 'CompleteAttachedFileUpload' => 'Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
', 'CreateAgentStatus' => 'This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
', 'CreateContactFlow' => 'Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
', 'CreateContactFlowModule' => 'Creates a flow module for the specified Amazon Connect instance.
', 'CreateEvaluationForm' => 'Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
', 'CreateHoursOfOperation' => 'This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
', 'CreateInstance' => 'This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
', 'CreateIntegrationAssociation' => 'Creates an Amazon Web Services resource association with an Amazon Connect instance.
', 'CreateParticipant' => 'Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
', 'CreatePersistentContactAssociation' => 'Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
', 'CreatePredefinedAttribute' => 'Creates a new predefined attribute for the specified Amazon Connect instance.
', 'CreatePrompt' => 'Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
', 'CreateQueue' => 'This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
Only use the phone number ARN format that doesn\'t contain instance
in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
Creates a quick connect for the specified Amazon Connect instance.
', 'CreateRoutingProfile' => 'Creates a new routing profile.
', 'CreateRule' => 'Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
', 'CreateSecurityProfile' => 'Creates a security profile.
', 'CreateTaskTemplate' => 'Creates a new task template in the specified Amazon Connect instance.
', 'CreateTrafficDistributionGroup' => 'Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
', 'CreateUseCase' => 'Creates a use case for an integration association.
', 'CreateUser' => 'Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some situations. For example, Email
is required if you are using SAML for identity management. FirstName
and LastName
are required if you are using Amazon Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
', 'CreateUserHierarchyGroup' => 'Creates a new user hierarchy group.
', 'CreateView' => 'Creates a new view with the possible status of SAVED
or PUBLISHED
.
The views will have a unique name for each connect instance.
It performs basic content validation if the status is SAVED
or full content validation if the status is set to PUBLISHED
. An error is returned if validation fails. It associates either the $SAVED
qualifier or both of the $SAVED
and $LATEST
qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.
Publishes a new version of the view identifier.
Versions are immutable and monotonically increasing.
It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST
alias.
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
', 'DeactivateEvaluationForm' => 'Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
', 'DeleteAttachedFile' => 'Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
Deletes a contact evaluation in the specified Amazon Connect instance.
', 'DeleteContactFlow' => 'Deletes a flow for the specified Amazon Connect instance.
', 'DeleteContactFlowModule' => 'Deletes the specified flow module.
', 'DeleteEvaluationForm' => 'Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
', 'DeleteInstance' => 'This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
', 'DeleteIntegrationAssociation' => 'Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
', 'DeletePredefinedAttribute' => 'Deletes a predefined attribute from the specified Amazon Connect instance.
', 'DeletePrompt' => 'Deletes a prompt.
', 'DeleteQueue' => 'Deletes a queue.
', 'DeleteQuickConnect' => 'Deletes a quick connect.
After calling DeleteUser, it\'s important to call DeleteQuickConnect
to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don\'t appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you\'re using Amazon Connect Global Resiliency.
Deletes a routing profile.
', 'DeleteRule' => 'Deletes a rule for the specified Amazon Connect instance.
', 'DeleteSecurityProfile' => 'Deletes a security profile.
', 'DeleteTaskTemplate' => 'Deletes the task template.
', 'DeleteTrafficDistributionGroup' => 'Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
', 'DeleteUseCase' => 'Deletes a use case from an integration association.
', 'DeleteUser' => 'Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user\'s data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don\'t appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you\'re using Amazon Connect Global Resiliency.
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
', 'DeleteView' => 'Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
', 'DeleteViewVersion' => 'Deletes the particular version specified in ViewVersion
identifier.
Deletes the vocabulary that has the given identifier.
', 'DescribeAgentStatus' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
', 'DescribeContact' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
Describes a contact evaluation in the specified Amazon Connect instance.
', 'DescribeContactFlow' => 'Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content. SAVED
does not initiate validation of the content. SAVED
| PUBLISHED
Describes the specified flow module.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
', 'DescribeHoursOfOperation' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
', 'DescribeInstance' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
', 'DescribeInstanceAttribute' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
', 'DescribeInstanceStorageConfig' => 'This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
', 'DescribePhoneNumber' => 'Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
Describes a predefined attribute for the specified Amazon Connect instance.
', 'DescribePrompt' => 'Describes the prompt.
', 'DescribeQueue' => 'This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
', 'DescribeQuickConnect' => 'Describes the quick connect.
', 'DescribeRoutingProfile' => 'Describes the specified routing profile.
', 'DescribeRule' => 'Describes a rule for the specified Amazon Connect instance.
', 'DescribeSecurityProfile' => 'Gets basic information about the security profle.
', 'DescribeTrafficDistributionGroup' => 'Gets details and status of a traffic distribution group.
', 'DescribeUser' => 'Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
', 'DescribeUserHierarchyGroup' => 'Describes the specified hierarchy group.
', 'DescribeUserHierarchyStructure' => 'Describes the hierarchy structure of the specified Amazon Connect instance.
', 'DescribeView' => 'Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED
needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED
, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST
. If it is not supplied, then $LATEST
is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.
Describes the specified vocabulary.
', 'DisassociateAnalyticsDataSet' => 'This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
', 'DisassociateApprovedOrigin' => 'This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
', 'DisassociateBot' => 'This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
', 'DisassociateFlow' => 'Disassociates a connect resource from a flow.
', 'DisassociateInstanceStorageConfig' => 'This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
', 'DisassociateLambdaFunction' => 'This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
', 'DisassociateLexBot' => 'This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
', 'DisassociatePhoneNumberContactFlow' => 'Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
', 'DisassociateRoutingProfileQueues' => 'Disassociates a set of queues from a routing profile.
', 'DisassociateSecurityKey' => 'This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
', 'DisassociateTrafficDistributionGroupUser' => 'Disassociates an agent from a traffic distribution group.
', 'DisassociateUserProficiencies' => 'Disassociates a set of proficiencies from a user.
', 'DismissUserContact' => 'Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED
, ERROR
, ENDED
, or REJECTED
state in the Agent Event Stream.
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED
.
Retrieves the contact attributes for the specified contact.
', 'GetCurrentMetricData' => 'Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
', 'GetCurrentUserData' => 'Gets the real-time active user data from the specified Amazon Connect instance.
', 'GetFederationToken' => 'Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn\'t support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
Retrieves the flow associated for a given resource.
', 'GetMetricData' => 'Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData
. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2
offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.
For a description of the historical metrics that are supported by GetMetricDataV2
and GetMetricData
, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Gets the prompt file.
', 'GetTaskTemplate' => 'Gets details about a specific task template in the specified Amazon Connect instance.
', 'GetTrafficDistribution' => 'Retrieves the current traffic distribution for a given traffic distribution group.
', 'ImportPhoneNumber' => 'Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber
operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
', 'ListAgentStatuses' => 'This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
', 'ListAnalyticsDataAssociations' => 'This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
', 'ListApprovedOrigins' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
', 'ListBots' => 'This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
', 'ListContactEvaluations' => 'Lists contact evaluations in the specified Amazon Connect instance.
', 'ListContactFlowModules' => 'Provides information about the flow modules for the specified Amazon Connect instance.
', 'ListContactFlows' => 'Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
', 'ListContactReferences' => 'This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes
, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.
Lists the default vocabularies for the specified Amazon Connect instance.
', 'ListEvaluationFormVersions' => 'Lists versions of an evaluation form in the specified Amazon Connect instance.
', 'ListEvaluationForms' => 'Lists evaluation forms in the specified Amazon Connect instance.
', 'ListFlowAssociations' => 'List the flow association based on the filters.
', 'ListHoursOfOperations' => 'Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
', 'ListInstanceAttributes' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
', 'ListInstanceStorageConfigs' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
', 'ListInstances' => 'This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren\'t successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
', 'ListIntegrationAssociations' => 'Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
', 'ListLambdaFunctions' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
', 'ListLexBots' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
', 'ListPhoneNumbers' => 'Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn\'t support number types UIFN
, SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE
or DID
.
The phone number Arn
value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException
. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
When given an instance ARN, ListPhoneNumbersV2
returns only the phone numbers claimed to the instance.
When given a traffic distribution group ARN ListPhoneNumbersV2
returns only the phone numbers claimed to the traffic distribution group.
Lists predefined attributes for the specified Amazon Connect instance.
', 'ListPrompts' => 'Provides information about the prompts for the specified Amazon Connect instance.
', 'ListQueueQuickConnects' => 'This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
', 'ListQueues' => 'Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes
parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
', 'ListQuickConnects' => 'Provides information about the quick connects for the specified Amazon Connect instance.
', 'ListRealtimeContactAnalysisSegmentsV2' => 'Provides a list of analysis segments for a real-time analysis session.
', 'ListRoutingProfileQueues' => 'Lists the queues associated with a routing profile.
', 'ListRoutingProfiles' => 'Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
', 'ListRules' => 'List all rules for the specified Amazon Connect instance.
', 'ListSecurityKeys' => 'This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
', 'ListSecurityProfileApplications' => 'Returns a list of third-party applications in a specific security profile.
', 'ListSecurityProfilePermissions' => 'Lists the permissions granted to a security profile.
', 'ListSecurityProfiles' => 'Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
', 'ListTagsForResource' => 'Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
', 'ListTaskTemplates' => 'Lists task templates for the specified Amazon Connect instance.
', 'ListTrafficDistributionGroupUsers' => 'Lists traffic distribution group users.
', 'ListTrafficDistributionGroups' => 'Lists traffic distribution groups.
', 'ListUseCases' => 'Lists the use cases for the integration association.
', 'ListUserHierarchyGroups' => 'Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
', 'ListUserProficiencies' => 'Lists proficiencies associated with a user.
', 'ListUsers' => 'Provides summary information about the users for the specified Amazon Connect instance.
', 'ListViewVersions' => 'Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
', 'ListViews' => 'Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
', 'MonitorContact' => 'Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
', 'PauseContact' => 'Allows pausing an ongoing task contact.
', 'PutUserStatus' => 'Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent\'s next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
', 'ReleasePhoneNumber' => 'Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber
API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
', 'ReplicateInstance' => 'Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
', 'ResumeContact' => 'Allows resuming a task contact in a paused state.
', 'ResumeContactRecording' => 'When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
', 'SearchAvailablePhoneNumbers' => 'Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
', 'SearchContactFlows' => 'Searches the contact flows in an Amazon Connect instance, with optional filtering.
', 'SearchContacts' => 'Searches contacts in an Amazon Connect instance.
', 'SearchHoursOfOperations' => 'Searches the hours of operation in an Amazon Connect instance, with optional filtering.
', 'SearchPredefinedAttributes' => 'Predefined attributes that meet certain criteria.
', 'SearchPrompts' => 'Searches prompts in an Amazon Connect instance, with optional filtering.
', 'SearchQueues' => 'Searches queues in an Amazon Connect instance, with optional filtering.
', 'SearchQuickConnects' => 'Searches quick connects in an Amazon Connect instance, with optional filtering.
', 'SearchResourceTags' => 'Searches tags used in an Amazon Connect instance using optional search criteria.
', 'SearchRoutingProfiles' => 'Searches routing profiles in an Amazon Connect instance, with optional filtering.
', 'SearchSecurityProfiles' => 'Searches security profiles in an Amazon Connect instance, with optional filtering.
', 'SearchUsers' => 'Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
Searches for vocabularies within a specific Amazon Connect instance using State
, NameStartsWith
, and LanguageCode
.
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
', 'StartAttachedFileUpload' => 'Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests
exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
', 'StartContactEvaluation' => 'Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
Evaluations created through the public API do not contain answer values suggested from automation.
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can\'t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
', 'StartContactStreaming' => 'Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
', 'StartOutboundVoiceContact' => 'Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that\'s specified (in ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType
= CAMPAIGN
, you must submit a service quota increase request to the quota Amazon Connect campaigns.
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId
and RelatedContactId
input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId
will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId
.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same RelatedContactId
.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID
, QuickConnectID
, or TaskTemplateID
. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID
is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException
occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId
. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
', 'StopContact' => 'Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
', 'StopContactRecording' => 'Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can\'t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
', 'StopContactStreaming' => 'Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
', 'SubmitContactEvaluation' => 'Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}
) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
', 'SuspendContactRecording' => 'When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
', 'TagContact' => 'Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
', 'TagResource' => 'Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
', 'TransferContact' => 'Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only TASK
contacts.
Do not use both QueueId
and UserId
in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact
API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
', 'UntagResource' => 'Removes the specified tags from the specified resource.
', 'UpdateAgentStatus' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
', 'UpdateContact' => 'This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer\'s name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
', 'UpdateContactEvaluation' => 'Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}
) to the question identifier.
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Updates metadata about specified flow.
', 'UpdateContactFlowModuleContent' => 'Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Updates metadata about specified flow module.
', 'UpdateContactFlowName' => 'The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
', 'UpdateContactRoutingData' => 'Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer\'s position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
Updates the scheduled time of a task contact that is already scheduled.
', 'UpdateEvaluationForm' => 'Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
', 'UpdateHoursOfOperation' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
', 'UpdateInstanceAttribute' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
', 'UpdateInstanceStorageConfig' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
', 'UpdateParticipantRoleConfig' => 'Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
', 'UpdatePhoneNumber' => 'Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn\'t migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
Updates a predefined attribute for the specified Amazon Connect instance.
', 'UpdatePrompt' => 'Updates a prompt.
', 'UpdateQueueHoursOfOperation' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
', 'UpdateQueueMaxContacts' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
', 'UpdateQueueName' => 'This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name
or Description
must be provided.
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
Only use the phone number ARN format that doesn\'t contain instance
in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
', 'UpdateQuickConnectConfig' => 'Updates the configuration settings for the specified quick connect.
', 'UpdateQuickConnectName' => 'Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name
or Description
must be provided.
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
', 'UpdateRoutingProfileConcurrency' => 'Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
', 'UpdateRoutingProfileDefaultOutboundQueue' => 'Updates the default outbound queue of a routing profile.
', 'UpdateRoutingProfileName' => 'Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name
or Description
must be provided.
Updates the properties associated with a set of queues for a routing profile.
', 'UpdateRule' => 'Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
', 'UpdateSecurityProfile' => 'Updates a security profile.
', 'UpdateTaskTemplate' => 'Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
', 'UpdateTrafficDistribution' => 'Updates the traffic distribution for a given traffic distribution group.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.
', 'UpdateUserHierarchy' => 'Assigns the specified hierarchy group to the specified user.
', 'UpdateUserHierarchyGroupName' => 'Updates the name of the user hierarchy group.
', 'UpdateUserHierarchyStructure' => 'Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
', 'UpdateUserIdentityInfo' => 'Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo
. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker\'s email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
Updates the phone configuration settings for the specified user.
', 'UpdateUserProficiencies' => 'Updates the properties associated with the proficiencies of a user.
', 'UpdateUserRoutingProfile' => 'Assigns the specified routing profile to the specified user.
', 'UpdateUserSecurityProfiles' => 'Assigns the specified security profiles to the specified user.
', 'UpdateViewContent' => 'Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status
is set to SAVED
and performs full content validation if Status
is PUBLISHED
. Note that the $SAVED
alias\' content will always be updated, but the $LATEST
alias\' content will only be updated if Status
is PUBLISHED
.
Updates the view metadata. Note that either Name
or Description
must be provided.
The Amazon Resource Name (ARN) for the evaluation form resource.
', 'AgentHierarchyGroup$Arn' => 'The Amazon Resource Name (ARN) of the group.
', 'AgentStatus$AgentStatusARN' => 'The Amazon Resource Name (ARN) of the agent status.
', 'AgentStatusReference$StatusArn' => 'The Amazon Resource Name (ARN) of the agent\'s status.
', 'AgentStatusSummary$Arn' => 'The Amazon Resource Name (ARN) for the agent status.
', 'AnalyticsDataAssociationResult$ResourceShareArn' => 'The Amazon Resource Name (ARN) of the Resource Access Manager share.
', 'AssociateAnalyticsDataSetResponse$ResourceShareArn' => 'The Amazon Resource Name (ARN) of the Resource Access Manager share.
', 'AssociateFlowRequest$ResourceId' => 'The identifier of the resource.
', 'AssociateFlowRequest$FlowId' => 'The identifier of the flow.
', 'AttachedFile$FileArn' => 'The unique identifier of the attached file resource (ARN).
', 'AttachedFile$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
The Amazon Resource Name (ARN) of the phone number.
', 'ClaimedPhoneNumberSummary$PhoneNumberArn' => 'The Amazon Resource Name (ARN) of the phone number.
', 'ClaimedPhoneNumberSummary$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
', 'ClaimedPhoneNumberSummary$SourcePhoneNumberArn' => 'The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
', 'CompleteAttachedFileUploadRequest$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The Amazon Resource Name (ARN) for the contact.
', 'ContactFlow$Arn' => 'The Amazon Resource Name (ARN) of the flow.
', 'ContactFlowModule$Arn' => 'The Amazon Resource Name (ARN).
', 'ContactFlowModuleSummary$Arn' => 'The Amazon Resource Name (ARN) of the flow module.
', 'ContactFlowSummary$Arn' => 'The Amazon Resource Name (ARN) of the flow.
', 'ContactSearchSummary$Arn' => 'The Amazon Resource Name (ARN) of the contact.
', 'CreateAgentStatusResponse$AgentStatusARN' => 'The Amazon Resource Name (ARN) of the agent status.
', 'CreateContactFlowModuleResponse$Arn' => 'The Amazon Resource Name (ARN) of the flow module.
', 'CreateContactFlowResponse$ContactFlowArn' => 'The Amazon Resource Name (ARN) of the flow.
', 'CreateEvaluationFormResponse$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'CreateHoursOfOperationResponse$HoursOfOperationArn' => 'The Amazon Resource Name (ARN) for the hours of operation.
', 'CreateInstanceResponse$Arn' => 'The Amazon Resource Name (ARN) of the instance.
', 'CreateIntegrationAssociationRequest$IntegrationArn' => 'The Amazon Resource Name (ARN) of the integration.
When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
The Amazon Resource Name (ARN) for the association.
', 'CreatePromptResponse$PromptARN' => 'The Amazon Resource Name (ARN) of the prompt.
', 'CreateQueueResponse$QueueArn' => 'The Amazon Resource Name (ARN) of the queue.
', 'CreateQuickConnectResponse$QuickConnectARN' => 'The Amazon Resource Name (ARN) for the quick connect.
', 'CreateRoutingProfileResponse$RoutingProfileArn' => 'The Amazon Resource Name (ARN) of the routing profile.
', 'CreateRuleResponse$RuleArn' => 'The Amazon Resource Name (ARN) of the rule.
', 'CreateSecurityProfileResponse$SecurityProfileArn' => 'The Amazon Resource Name (ARN) for the security profile.
', 'CreateUseCaseResponse$UseCaseArn' => 'The Amazon Resource Name (ARN) for the use case.
', 'CreateUserHierarchyGroupResponse$HierarchyGroupArn' => 'The Amazon Resource Name (ARN) of the hierarchy group.
', 'CreateUserResponse$UserArn' => 'The Amazon Resource Name (ARN) of the user account.
', 'CreateVocabularyResponse$VocabularyArn' => 'The Amazon Resource Name (ARN) of the custom vocabulary.
', 'CreatedByInfo$ConnectUserArn' => 'An agent ARN representing a connect user.
', 'CreatedByInfo$AWSIdentityArn' => 'STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn
is not provided.
The Amazon Resource Name (ARN) for the evaluation form resource.
', 'DeleteAttachedFileRequest$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The Amazon Resource Name (ARN) of the custom vocabulary.
', 'DisassociateFlowRequest$ResourceId' => 'The identifier of the resource.
', 'Evaluation$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'EvaluationForm$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'EvaluationForm$CreatedBy' => 'The Amazon Resource Name (ARN) of the user who created the evaluation form.
', 'EvaluationForm$LastModifiedBy' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
', 'EvaluationFormContent$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'EvaluationFormSummary$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'EvaluationFormSummary$CreatedBy' => 'The Amazon Resource Name (ARN) of the user who created the evaluation form.
', 'EvaluationFormSummary$LastModifiedBy' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
', 'EvaluationFormSummary$LastActivatedBy' => 'The Amazon Resource Name (ARN) of the user who last activated the evaluation form.
', 'EvaluationFormVersionSummary$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the evaluation form resource.
', 'EvaluationFormVersionSummary$CreatedBy' => 'The Amazon Resource Name (ARN) of the user who created the evaluation form.
', 'EvaluationFormVersionSummary$LastModifiedBy' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
', 'EvaluationMetadata$EvaluatorArn' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation.
', 'EvaluationSummary$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'EvaluationSummary$EvaluatorArn' => 'The Amazon Resource Name (ARN) of the user who last updated the evaluation.
', 'FlowAssociationSummary$ResourceId' => 'The identifier of the resource.
', 'FlowAssociationSummary$FlowId' => 'The identifier of the flow.
', 'GetAttachedFileRequest$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource (ARN).
', 'GetAttachedFileResponse$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
', 'GetFederationTokenResponse$UserArn' => 'The Amazon Resource Name (ARN) of the user.
', 'GetFlowAssociationRequest$ResourceId' => 'The identifier of the resource.
', 'GetFlowAssociationResponse$ResourceId' => 'The identifier of the resource.
', 'GetFlowAssociationResponse$FlowId' => 'The identifier of the flow.
', 'GetMetricDataV2Request$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource. This includes the instanceId
an Amazon Connect instance.
The Amazon Resource Name (ARN) of the hierarchy group.
', 'HierarchyGroupSummary$Arn' => 'The Amazon Resource Name (ARN) of the hierarchy group.
', 'HierarchyGroupSummaryReference$Arn' => 'The Amazon Resource Name (ARN) for the hierarchy group.
', 'HierarchyLevel$Arn' => 'The Amazon Resource Name (ARN) of the hierarchy level.
', 'HoursOfOperation$HoursOfOperationArn' => 'The Amazon Resource Name (ARN) for the hours of operation.
', 'HoursOfOperationSummary$Arn' => 'The Amazon Resource Name (ARN) of the hours of operation.
', 'ImportPhoneNumberRequest$SourcePhoneNumberArn' => 'The claimed phone number ARN being imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number to import from Amazon Pinpoint.
', 'ImportPhoneNumberResponse$PhoneNumberArn' => 'The Amazon Resource Name (ARN) of the phone number.
', 'Instance$Arn' => 'The Amazon Resource Name (ARN) of the instance.
', 'Instance$ServiceRole' => 'The service role of the instance.
', 'InstanceSummary$Arn' => 'The Amazon Resource Name (ARN) of the instance.
', 'InstanceSummary$ServiceRole' => 'The service role of the instance.
', 'IntegrationAssociationSummary$IntegrationAssociationArn' => 'The Amazon Resource Name (ARN) for the AppIntegration association.
', 'IntegrationAssociationSummary$IntegrationArn' => 'The Amazon Resource Name (ARN) for the AppIntegration.
', 'KinesisFirehoseConfig$FirehoseArn' => 'The Amazon Resource Name (ARN) of the delivery stream.
', 'KinesisStreamConfig$StreamArn' => 'The Amazon Resource Name (ARN) of the data stream.
', 'ListIntegrationAssociationsRequest$IntegrationArn' => 'The Amazon Resource Name (ARN) of the integration.
', 'ListPhoneNumbersSummary$PhoneNumberArn' => 'The Amazon Resource Name (ARN) of the phone number.
', 'ListPhoneNumbersSummary$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
', 'ListPhoneNumbersSummary$SourcePhoneNumberArn' => 'The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
', 'ListPhoneNumbersV2Request$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both TargetArn
and InstanceId
input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.
', 'MonitorContactResponse$ContactArn' => 'The ARN of the contact.
', 'PhoneNumberSummary$Arn' => 'The Amazon Resource Name (ARN) of the phone number.
', 'Prompt$PromptARN' => 'The Amazon Resource Name (ARN) of the prompt.
', 'PromptSummary$Arn' => 'The Amazon Resource Name (ARN) of the prompt.
', 'Queue$QueueArn' => 'The Amazon Resource Name (ARN) for the queue.
', 'QueueReference$Arn' => 'The Amazon Resource Name (ARN) of the queue.
', 'QueueSummary$Arn' => 'The Amazon Resource Name (ARN) of the queue.
', 'QuickConnect$QuickConnectARN' => 'The Amazon Resource Name (ARN) of the quick connect.
', 'QuickConnectSummary$Arn' => 'The Amazon Resource Name (ARN) of the quick connect.
', 'ReplicateInstanceResponse$Arn' => 'The Amazon Resource Name (ARN) of the replicated instance.
', 'ResourceInUseException$ResourceId' => 'The identifier for the resource.
', 'RoutingProfile$RoutingProfileArn' => 'The Amazon Resource Name (ARN) of the routing profile.
', 'RoutingProfileQueueConfigSummary$QueueArn' => 'The Amazon Resource Name (ARN) of the queue.
', 'RoutingProfileReference$Arn' => 'The Amazon Resource Name (ARN) of the routing profile.
', 'RoutingProfileSummary$Arn' => 'The Amazon Resource Name (ARN) of the routing profile.
', 'Rule$RuleArn' => 'The Amazon Resource Name (ARN) of the rule.
', 'Rule$LastUpdatedBy' => 'The Amazon Resource Name (ARN) of the user who last updated the rule.
', 'RuleSummary$RuleArn' => 'The Amazon Resource Name (ARN) of the rule.
', 'SearchAvailablePhoneNumbersRequest$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
The Amazon Resource Name (ARN) for the secruity profile.
', 'SecurityProfileSearchSummary$Arn' => 'The Amazon Resource Name (ARN) of the security profile.
', 'SecurityProfileSummary$Arn' => 'The Amazon Resource Name (ARN) of the security profile.
', 'StartAttachedFileUploadRequest$AssociatedResourceArn' => 'The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource (ARN).
', 'StartContactEvaluationResponse$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'SubmitContactEvaluationResponse$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'TransferContactResponse$ContactArn' => 'The Amazon Resource Name (ARN) of the contact.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'UpdateContactEvaluationResponse$EvaluationArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'UpdateEvaluationFormResponse$EvaluationFormArn' => 'The Amazon Resource Name (ARN) for the contact evaluation resource.
', 'UpdatePhoneNumberRequest$TargetArn' => 'The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId
or TargetArn
.
The Amazon Resource Name (ARN) of the phone number.
', 'UpdatePromptResponse$PromptARN' => 'The Amazon Resource Name (ARN) of the prompt.
', 'UseCase$UseCaseArn' => 'The Amazon Resource Name (ARN) for the use case.
', 'User$Arn' => 'The Amazon Resource Name (ARN) of the user account.
', 'UserReference$Arn' => 'The Amazon Resource Name (ARN) for the user.
', 'UserSearchSummary$Arn' => 'The Amazon Resource Name (ARN) of the user.
', 'UserSummary$Arn' => 'The Amazon Resource Name (ARN) of the user account.
', 'View$Arn' => 'The Amazon Resource Name (ARN) of the view.
', 'ViewSummary$Arn' => 'The Amazon Resource Name (ARN) of the view.
', 'ViewVersionSummary$Arn' => 'The Amazon Resource Name (ARN) of the view version.
', 'Vocabulary$Arn' => 'The Amazon Resource Name (ARN) of the custom vocabulary.
', 'VocabularySummary$Arn' => 'The Amazon Resource Name (ARN) of the custom vocabulary.
', 'WisdomInfo$SessionArn' => 'The Amazon Resource Name (ARN) of the Wisdom session.
', 'resourceArnListMaxLimit100$member' => NULL, ], ], 'AWSAccountId' => [ 'base' => NULL, 'refs' => [ 'AnalyticsDataAssociationResult$TargetAccountId' => 'The identifier of the target account.
', 'AssociateAnalyticsDataSetRequest$TargetAccountId' => 'The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
', 'AssociateAnalyticsDataSetResponse$TargetAccountId' => 'The identifier of the target account.
', 'BatchAssociateAnalyticsDataSetRequest$TargetAccountId' => 'The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
', 'BatchDisassociateAnalyticsDataSetRequest$TargetAccountId' => 'The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
', 'DisassociateAnalyticsDataSetRequest$TargetAccountId' => 'The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
', ], ], 'AccessDeniedException' => [ 'base' => 'You do not have sufficient permissions to perform this action.
', 'refs' => [], ], 'ActionSummaries' => [ 'base' => NULL, 'refs' => [ 'RuleSummary$ActionSummaries' => 'A list of ActionTypes associated with a rule.
', ], ], 'ActionSummary' => [ 'base' => 'Information about an action.
', 'refs' => [ 'ActionSummaries$member' => NULL, ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'ActionSummary$ActionType' => 'The action type.
', 'RuleAction$ActionType' => 'The type of action that creates a rule.
', ], ], 'ActivateEvaluationFormRequest' => [ 'base' => NULL, 'refs' => [], ], 'ActivateEvaluationFormResponse' => [ 'base' => NULL, 'refs' => [], ], 'AfterContactWorkTimeLimit' => [ 'base' => NULL, 'refs' => [ 'UserPhoneConfig$AfterContactWorkTimeLimit' => 'The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don\'t want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.
When returned by a SearchUsers
call, AfterContactWorkTimeLimit
is returned in milliseconds.
Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
', 'RoutingProfile$AgentAvailabilityTimer' => 'Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
', 'UpdateRoutingProfileAgentAvailabilityTimerRequest$AgentAvailabilityTimer' => 'Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
', ], ], 'AgentConfig' => [ 'base' => 'The distribution of agents between the instance and its replica(s).
', 'refs' => [ 'GetTrafficDistributionResponse$AgentConfig' => 'The distribution of agents between the instance and its replica(s).
', 'UpdateTrafficDistributionRequest$AgentConfig' => 'The distribution of agents between the instance and its replica(s).
', ], ], 'AgentContactReference' => [ 'base' => 'Information about the contact associated to the user.
', 'refs' => [ 'AgentContactReferenceList$member' => NULL, ], ], 'AgentContactReferenceList' => [ 'base' => NULL, 'refs' => [ 'UserData$Contacts' => 'A list of contact reference information.
', ], ], 'AgentFirstName' => [ 'base' => NULL, 'refs' => [ 'UserIdentityInfo$FirstName' => 'The first name. This is required if you are using Amazon Connect or SAML for identity management.
', 'UserIdentityInfoLite$FirstName' => 'The user\'s first name.
', ], ], 'AgentHierarchyGroup' => [ 'base' => 'Information about an agent hierarchy group.
', 'refs' => [ 'HierarchyGroups$Level1' => 'The group at level one of the agent hierarchy.
', 'HierarchyGroups$Level2' => 'The group at level two of the agent hierarchy.
', 'HierarchyGroups$Level3' => 'The group at level three of the agent hierarchy.
', 'HierarchyGroups$Level4' => 'The group at level four of the agent hierarchy.
', 'HierarchyGroups$Level5' => 'The group at level five of the agent hierarchy.
', ], ], 'AgentHierarchyGroups' => [ 'base' => 'A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
', 'refs' => [ 'SearchCriteria$AgentHierarchyGroups' => 'The agent hierarchy groups of the agent at the time of handling the contact.
', ], ], 'AgentId' => [ 'base' => NULL, 'refs' => [ 'AgentIds$member' => NULL, ], ], 'AgentIds' => [ 'base' => NULL, 'refs' => [ 'AgentsCriteria$AgentIds' => 'An object to specify a list of agents, by Agent ID.
', ], ], 'AgentInfo' => [ 'base' => 'Information about the agent who accepted the contact.
', 'refs' => [ 'Contact$AgentInfo' => 'Information about the agent who accepted the contact.
', ], ], 'AgentLastName' => [ 'base' => NULL, 'refs' => [ 'UserIdentityInfo$LastName' => 'The last name. This is required if you are using Amazon Connect or SAML for identity management.
', 'UserIdentityInfoLite$LastName' => 'The user\'s last name.
', ], ], 'AgentPauseDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'AgentInfo$AgentPauseDurationInSeconds' => 'Agent pause duration for a contact in seconds.
', ], ], 'AgentQualityMetrics' => [ 'base' => 'Information about the quality of the Agent\'s media connection
', 'refs' => [ 'QualityMetrics$Agent' => 'Information about the quality of Agent media connection.
', ], ], 'AgentResourceId' => [ 'base' => NULL, 'refs' => [ 'AgentInfo$Id' => 'The identifier of the agent who accepted the contact.
', 'AgentResourceIdList$member' => NULL, 'ContactSearchSummaryAgentInfo$Id' => 'The identifier of the agent who accepted the contact.
', 'GetFederationTokenResponse$UserId' => 'The identifier for the user. This can be the ID or the ARN of the user.
', 'MonitorContactRequest$UserId' => 'The identifier of the user account.
', 'TransferContactRequest$UserId' => 'The identifier for the user. This can be the ID or the ARN of the user.
', ], ], 'AgentResourceIdList' => [ 'base' => NULL, 'refs' => [ 'SearchCriteria$AgentIds' => 'The identifiers of agents who handled the contacts.
', ], ], 'AgentStatus' => [ 'base' => 'Contains information about an agent status.
', 'refs' => [ 'DescribeAgentStatusResponse$AgentStatus' => 'The agent status.
', ], ], 'AgentStatusDescription' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$Description' => 'The description of the agent status.
', 'CreateAgentStatusRequest$Description' => 'The description of the status.
', ], ], 'AgentStatusId' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$AgentStatusId' => 'The identifier of the agent status.
', 'AgentStatusSummary$Id' => 'The identifier for an agent status.
', 'CreateAgentStatusResponse$AgentStatusId' => 'The identifier of the agent status.
', 'DescribeAgentStatusRequest$AgentStatusId' => 'The identifier for the agent status.
', 'PutUserStatusRequest$AgentStatusId' => 'The identifier of the agent status.
', 'UpdateAgentStatusRequest$AgentStatusId' => 'The identifier of the agent status.
', ], ], 'AgentStatusName' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$Name' => 'The name of the agent status.
', 'AgentStatusReference$StatusName' => 'The name of the agent status.
', 'AgentStatusSummary$Name' => 'The name of the agent status.
', 'CreateAgentStatusRequest$Name' => 'The name of the status.
', 'UpdateAgentStatusRequest$Name' => 'The name of the agent status.
', 'UserData$NextStatus' => 'The Next status of the agent.
', ], ], 'AgentStatusOrderNumber' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$DisplayOrder' => 'The display order of the agent status.
', 'CreateAgentStatusRequest$DisplayOrder' => 'The display order of the status.
', 'UpdateAgentStatusRequest$DisplayOrder' => 'The display order of the agent status.
', ], ], 'AgentStatusReference' => [ 'base' => 'Information about the agent\'s status.
', 'refs' => [ 'UserData$Status' => 'The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
', ], ], 'AgentStatusState' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$State' => 'The state of the agent status.
', 'CreateAgentStatusRequest$State' => 'The state of the status.
', 'UpdateAgentStatusRequest$State' => 'The state of the agent status.
', ], ], 'AgentStatusSummary' => [ 'base' => 'Summary information for an agent status.
', 'refs' => [ 'AgentStatusSummaryList$member' => NULL, ], ], 'AgentStatusSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAgentStatusResponse$AgentStatusSummaryList' => 'A summary of agent statuses.
', ], ], 'AgentStatusType' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$Type' => 'The type of agent status.
', 'AgentStatusSummary$Type' => 'The type of the agent status.
', 'AgentStatusTypes$member' => NULL, ], ], 'AgentStatusTypes' => [ 'base' => NULL, 'refs' => [ 'ListAgentStatusRequest$AgentStatusTypes' => 'Available agent status types.
', ], ], 'AgentUsername' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Username' => 'The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+.
Username can include @ only if used in an email format. For example:
Correct: testuser
Correct: testuser@example.com
Incorrect: testuser@example
The user name assigned to the user account.
', 'UserSearchSummary$Username' => 'The name of the user.
', 'UserSummary$Username' => 'The Amazon Connect user name of the user account.
', ], ], 'AgentsCriteria' => [ 'base' => 'Can be used to define a list of preferred agents to target the contact within the queue. Note that agents must have the queue in their routing profile in order to be offered the contact.
', 'refs' => [ 'MatchCriteria$AgentsCriteria' => 'An object to define AgentIds
.
A list of up to 100 agent IDs or ARNs.
', ], ], 'AliasArn' => [ 'base' => NULL, 'refs' => [ 'LexV2Bot$AliasArn' => 'The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
', ], ], 'AllowedAccessControlTags' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$AllowedAccessControlTags' => 'The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
', 'SecurityProfile$AllowedAccessControlTags' => 'The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
', 'UpdateSecurityProfileRequest$AllowedAccessControlTags' => 'The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
', ], ], 'AllowedCapabilities' => [ 'base' => 'Information about the capabilities enabled for participants of the contact.
', 'refs' => [ 'StartWebRTCContactRequest$AllowedCapabilities' => 'Information about the video sharing capabilities of the participants (customer, agent).
', ], ], 'AllowedMonitorCapabilities' => [ 'base' => NULL, 'refs' => [ 'MonitorContactRequest$AllowedMonitorCapabilities' => 'Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.
', ], ], 'AnalyticsDataAssociationResult' => [ 'base' => 'This API is in preview release for Amazon Connect and is subject to change.
Information about associations that are successfully created: DataSetId
, TargetAccountId
, ResourceShareId
, ResourceShareArn
.
Information about associations that are successfully created: DataSetId
, TargetAccountId
, ResourceShareId
, ResourceShareArn
.
An array of successful results: DataSetId
, TargetAccountId
, ResourceShareId
, ResourceShareArn
. This is a paginated API, so nextToken
is given if there are more results to be returned.
Configuration of the answering machine detection.
', 'refs' => [ 'StartOutboundVoiceContactRequest$AnswerMachineDetectionConfig' => 'Configuration of the answering machine detection for this outbound call.
', ], ], 'AnsweringMachineDetectionStatus' => [ 'base' => NULL, 'refs' => [ 'Contact$AnsweringMachineDetectionStatus' => 'Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
', ], ], 'Application' => [ 'base' => 'This API is in preview release for Amazon Connect and is subject to change.
A third-party application\'s metadata.
', 'refs' => [ 'Applications$member' => NULL, ], ], 'ApplicationPermissions' => [ 'base' => NULL, 'refs' => [ 'Application$ApplicationPermissions' => 'The permissions that the agent is granted on the application. Only the ACCESS
permission is supported.
A list of third-party applications that the security profile will give access to.
', 'ListSecurityProfileApplicationsResponse$Applications' => 'A list of the third-party application\'s metadata.
', 'UpdateSecurityProfileRequest$Applications' => 'A list of the third-party application\'s metadata.
', ], ], 'ApproximateTotalCount' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataResponse$ApproximateTotalCount' => 'The total count of the result, regardless of the current page size.
', 'GetCurrentUserDataResponse$ApproximateTotalCount' => 'The total count of the result, regardless of the current page size.
', 'SearchContactFlowModulesResponse$ApproximateTotalCount' => 'The total number of contact flows which matched your search query.
', 'SearchContactFlowsResponse$ApproximateTotalCount' => 'The total number of contact flows which matched your search query.
', 'SearchHoursOfOperationsResponse$ApproximateTotalCount' => 'The total number of hours of operations which matched your search query.
', 'SearchPredefinedAttributesResponse$ApproximateTotalCount' => 'The approximate number of predefined attributes which matched your search query.
', 'SearchPromptsResponse$ApproximateTotalCount' => 'The total number of quick connects which matched your search query.
', 'SearchQueuesResponse$ApproximateTotalCount' => 'The total number of queues which matched your search query.
', 'SearchQuickConnectsResponse$ApproximateTotalCount' => 'The total number of quick connects which matched your search query.
', 'SearchRoutingProfilesResponse$ApproximateTotalCount' => 'The total number of routing profiles which matched your search query.
', 'SearchSecurityProfilesResponse$ApproximateTotalCount' => 'The total number of security profiles which matched your search query.
', 'SearchUsersResponse$ApproximateTotalCount' => 'The total number of users who matched your search query.
', ], ], 'ArtifactId' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisAttachment$AttachmentId' => 'A unique identifier for the attachment.
', ], ], 'ArtifactStatus' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisAttachment$Status' => 'Status of the attachment.
', ], ], 'AssignContactCategoryActionDefinition' => [ 'base' => 'This action must be set if TriggerEventSource
is one of the following values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
. Contact is categorized using the rule name.
RuleName
is used as ContactCategory
.
Information about the contact category action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
The IDs of the associated queue.
', ], ], 'AssociationId' => [ 'base' => NULL, 'refs' => [ 'AssociateInstanceStorageConfigResponse$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'AssociateSecurityKeyResponse$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'DescribeInstanceStorageConfigRequest$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'DisassociateInstanceStorageConfigRequest$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'DisassociateSecurityKeyRequest$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'InstanceStorageConfig$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'SecurityKey$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', 'UpdateInstanceStorageConfigRequest$AssociationId' => 'The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
', ], ], 'AttachedFile' => [ 'base' => 'Information about the attached file.
', 'refs' => [ 'AttachedFilesList$member' => NULL, ], ], 'AttachedFileError' => [ 'base' => 'Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
', 'refs' => [ 'AttachedFileErrorsList$member' => NULL, ], ], 'AttachedFileErrorsList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAttachedFileMetadataResponse$Errors' => 'List of errors of attached files that could not be retrieved.
', ], ], 'AttachedFileInvalidRequestExceptionReason' => [ 'base' => NULL, 'refs' => [ 'InvalidRequestExceptionReason$AttachedFileInvalidRequestExceptionReason' => 'Reason why the StartAttachedFiledUpload request was invalid.
', ], ], 'AttachedFilesList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAttachedFileMetadataResponse$Files' => 'List of attached files that were successfully retrieved.
', ], ], 'AttachmentName' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisAttachment$AttachmentName' => 'A case-sensitive name of the attachment being uploaded. Can be redacted.
', ], ], 'AttachmentReference' => [ 'base' => 'Information about a reference when the referenceType
is ATTACHMENT
. Otherwise, null.
Information about the reference when the referenceType
is ATTACHMENT
. Otherwise, null.
The attendee information, including attendee ID and join token.
', 'refs' => [ 'ConnectionData$Attendee' => 'The attendee information, including attendee ID and join token.
', ], ], 'AttendeeId' => [ 'base' => NULL, 'refs' => [ 'Attendee$AttendeeId' => 'The Amazon Chime SDK attendee ID.
', ], ], 'Attribute' => [ 'base' => 'A toggle for an individual feature at the instance level.
', 'refs' => [ 'AttributesList$member' => NULL, 'DescribeInstanceAttributeResponse$Attribute' => 'The type of attribute.
', ], ], 'AttributeAndCondition' => [ 'base' => 'A list of conditions which would be applied together with an AND
condition.
A list of conditions which would be applied together with an AND
condition.
An object to specify the predefined attribute condition.
', 'refs' => [ 'Expression$AttributeCondition' => 'An object to specify the predefined attribute condition.
', ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'Attributes$key' => NULL, ], ], 'AttributeOrConditionList' => [ 'base' => NULL, 'refs' => [ 'ControlPlaneUserAttributeFilter$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
List of attributes to be stored in a contact.
', 'GetContactAttributesResponse$Attributes' => 'Information about the attributes.
', 'NewSessionDetails$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'StartChatContactRequest$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'StartOutboundVoiceContactRequest$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'StartTaskContactRequest$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
', 'StartWebRTCContactRequest$Attributes' => 'A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.
', 'UpdateContactAttributesRequest$Attributes' => 'The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:
Remove unnecessary attributes by setting their values to empty.
If the attributes are only used in one flow and don\'t need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren\'t needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
The attribute types.
', ], ], 'AudioFeatures' => [ 'base' => 'Has audio-specific configurations as the operating parameter for Echo Reduction.
', 'refs' => [ 'MeetingFeaturesConfiguration$Audio' => 'The configuration settings for the audio features available to a meeting.
', ], ], 'AudioQualityMetricsInfo' => [ 'base' => 'Contains information for score and potential quality issues for Audio
', 'refs' => [ 'AgentQualityMetrics$Audio' => 'Information about the audio quality of the Agent
', 'CustomerQualityMetrics$Audio' => 'Information about the audio quality of the Customer
', ], ], 'AudioQualityScore' => [ 'base' => NULL, 'refs' => [ 'AudioQualityMetricsInfo$QualityScore' => 'Number measuring the estimated quality of the media connection.
', ], ], 'AutoAccept' => [ 'base' => NULL, 'refs' => [ 'UserPhoneConfig$AutoAccept' => 'The Auto accept setting.
', ], ], 'AvailableNumberSummary' => [ 'base' => 'Information about available phone numbers.
', 'refs' => [ 'AvailableNumbersList$member' => NULL, ], ], 'AvailableNumbersList' => [ 'base' => NULL, 'refs' => [ 'SearchAvailablePhoneNumbersResponse$AvailableNumbersList' => 'A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
', ], ], 'AwsRegion' => [ 'base' => NULL, 'refs' => [ 'Distribution$Region' => 'The Amazon Web Services Region where the traffic is distributed.
', 'ReplicateInstanceRequest$ReplicaRegion' => 'The Amazon Web Services Region where to replicate the Amazon Connect instance.
', 'SignInDistribution$Region' => 'The Amazon Web Services Region of the sign in distribution.
', ], ], 'BatchAssociateAnalyticsDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchAssociateAnalyticsDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateAnalyticsDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDisassociateAnalyticsDataSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetAttachedFileMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetAttachedFileMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetFlowAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetFlowAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchPutContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'BehaviorType' => [ 'base' => NULL, 'refs' => [ 'CrossChannelBehavior$BehaviorType' => 'Specifies the other channels that can be routed to an agent handling their current channel.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AnswerMachineDetectionConfig$EnableAnswerMachineDetection' => 'The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true
, TrafficType
must be set as CAMPAIGN
.
Wait for the answering machine prompt.
', 'EvaluationAnswerData$NotApplicable' => 'The flag to mark the question as not applicable.
', 'EvaluationFormNumericQuestionOption$AutomaticFail' => 'The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
', 'EvaluationFormQuestion$NotApplicableEnabled' => 'The flag to enable not applicable answers to the question.
', 'EvaluationFormSingleSelectQuestionOption$AutomaticFail' => 'The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
', 'EvaluationScore$NotApplicable' => 'The flag to mark the item as not applicable for scoring.
', 'EvaluationScore$AutomaticFail' => 'The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
', 'FieldValueUnion$BooleanValue' => 'A Boolean number value type.
', 'MetricFilterV2$Negate' => 'The flag to use to filter on requested metric filter values or to not filter on requested metric filter values. By default the negate is false
, which indicates to filter on the requested metric filter.
Whether this a default routing profile.
', 'SignInDistribution$Enabled' => 'Whether sign in distribution is enabled.
', 'TrafficDistributionGroup$IsDefault' => 'Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup
API. The default traffic distribution group is deleted as part of the process for deleting a replica.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig
and a non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup
API. The default traffic distribution group is deleted as part of the process for deleting a replica.
A number indicating the reset order of the agent status.
', ], ], 'BotName' => [ 'base' => NULL, 'refs' => [ 'DisassociateLexBotRequest$BotName' => 'The name of the Amazon Lex bot. Maximum character limit of 50.
', 'LexBot$Name' => 'The name of the Amazon Lex bot.
', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'UpdateEvaluationFormRequest$CreateNewVersion' => 'A flag indicating whether the operation must create a new version.
', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Config$BucketName' => 'The S3 bucket name.
', ], ], 'Campaign' => [ 'base' => 'Information associated with a campaign.
', 'refs' => [ 'Contact$Campaign' => NULL, 'ContactDataRequest$Campaign' => 'Structure to store information associated with a campaign.
', ], ], 'CampaignId' => [ 'base' => NULL, 'refs' => [ 'Campaign$CampaignId' => 'A unique identifier for a campaign.
', 'StartOutboundVoiceContactRequest$CampaignId' => 'The campaign identifier of the outbound communication.
', ], ], 'Channel' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$Channel' => 'The channel of the contact.
', 'ChannelList$member' => NULL, 'ChannelToCountMap$key' => NULL, 'Channels$member' => NULL, 'Contact$Channel' => 'How the contact reached your contact center.
', 'ContactSearchSummary$Channel' => 'How the contact reached your contact center.
', 'Dimensions$Channel' => 'The channel used for grouping and filters.
', 'MediaConcurrency$Channel' => 'The channels that agents can handle in the Contact Control Panel (CCP).
', 'RoutingProfileQueueConfigSummary$Channel' => 'The channels this queue supports.
', 'RoutingProfileQueueReference$Channel' => 'The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
', ], ], 'ChannelList' => [ 'base' => NULL, 'refs' => [ 'SearchCriteria$Channels' => 'The list of channels associated with contacts.
', ], ], 'ChannelToCountMap' => [ 'base' => NULL, 'refs' => [ 'UserData$AvailableSlotsByChannel' => 'A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
', 'UserData$MaxSlotsByChannel' => 'A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile
assigned to the agent.
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
', ], ], 'Channels' => [ 'base' => NULL, 'refs' => [ 'Filters$Channels' => 'The channel to use to filter the metrics.
', ], ], 'ChatContent' => [ 'base' => NULL, 'refs' => [ 'ChatEvent$Content' => 'Content of the message or event. This is required when Type
is MESSAGE
and for certain ContentTypes
when Type
is EVENT
.
For allowed message content, see the Content
parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
For allowed event content, see the Content
parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
The content of the chat message.
For text/plain
and text/markdown
, the Length Constraints are Minimum of 1, Maximum of 1024.
For application/json
, the Length Constraints are Minimum of 1, Maximum of 12000.
For application/vnd.amazonaws.connect.message.interactive.response
, the Length Constraints are Minimum of 1, Maximum of 12288.
Type of content. This is required when Type
is MESSAGE
or EVENT
.
For allowed message content types, see the ContentType
parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
For allowed event content types, see the ContentType
parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
The type of the content. Supported types are text/plain
, text/markdown
, application/json
, and application/vnd.amazonaws.connect.message.interactive.response
.
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
', ], ], 'ChatEvent' => [ 'base' => 'Chat integration event containing payload to perform different chat actions such as:
Sending a chat message
Sending a chat event, such as typing
Disconnecting from a chat
Chat integration event payload
', ], ], 'ChatEventType' => [ 'base' => NULL, 'refs' => [ 'ChatEvent$Type' => 'Type of chat integration event.
', ], ], 'ChatMessage' => [ 'base' => 'A chat message.
', 'refs' => [ 'StartChatContactRequest$InitialMessage' => 'The initial message to be sent to the newly created chat. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.
', ], ], 'ChatParticipantRoleConfig' => [ 'base' => 'Configuration information for the chat participant role.
', 'refs' => [ 'UpdateParticipantRoleConfigChannelInfo$Chat' => 'Configuration information for the chat participant role.
', ], ], 'ChatStreamingConfiguration' => [ 'base' => 'The streaming configuration, such as the Amazon SNS streaming endpoint.
', 'refs' => [ 'NewSessionDetails$StreamingConfiguration' => NULL, 'StartContactStreamingRequest$ChatStreamingConfiguration' => 'The streaming configuration, such as the Amazon SNS streaming endpoint.
', ], ], 'ChatStreamingEndpointARN' => [ 'base' => NULL, 'refs' => [ 'ChatStreamingConfiguration$StreamingEndpointArn' => 'The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.
', ], ], 'ClaimPhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ClaimPhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'ClaimedPhoneNumberSummary' => [ 'base' => 'Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
', 'refs' => [ 'DescribePhoneNumberResponse$ClaimedPhoneNumberSummary' => 'Information about a phone number that\'s been claimed to your Amazon Connect instance or traffic distribution group.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'BatchPutContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'ClaimPhoneNumberRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateEvaluationFormRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateInstanceRequest$ClientToken' => 'The idempotency token.
', 'CreateParticipantRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreatePersistentContactAssociationRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateRuleRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateTaskTemplateRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateTrafficDistributionGroupRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateVocabularyRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
', 'ImportPhoneNumberRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'MonitorContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'ReleasePhoneNumberRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'ReplicateInstanceRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartAttachedFileUploadRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartChatContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartContactEvaluationRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartContactStreamingRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartOutboundVoiceContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
', 'StartTaskContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'StartWebRTCContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
', 'TransferContactRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'UpdateEvaluationFormRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'UpdatePhoneNumberMetadataRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'UpdatePhoneNumberRequest$ClientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', ], ], 'CommonNameLength127' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationRequest$Name' => 'The name of the hours of operation.
', 'CreatePromptRequest$Name' => 'The name of the prompt.
', 'CreateQueueRequest$Name' => 'The name of the queue.
', 'HoursOfOperation$Name' => 'The name for the hours of operation.
', 'Prompt$Name' => 'The name of the prompt.
', 'Queue$Name' => 'The name of the queue.
', 'UpdateHoursOfOperationRequest$Name' => 'The name of the hours of operation.
', 'UpdatePromptRequest$Name' => 'The name of the prompt.
', 'UpdateQueueNameRequest$Name' => 'The name of the queue.
', ], ], 'Comparison' => [ 'base' => NULL, 'refs' => [ 'Threshold$Comparison' => 'The type of comparison. Only "less than" (LT) comparisons are supported.
', ], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'AttributeCondition$ComparisonOperator' => 'The operator of the condition.
', ], ], 'CompleteAttachedFileUploadRequest' => [ 'base' => 'Request to CompleteAttachedFileUpload API', 'refs' => [], ], 'CompleteAttachedFileUploadResponse' => [ 'base' => 'Response from CompleteAttachedFileUpload API', 'refs' => [], ], 'Concurrency' => [ 'base' => NULL, 'refs' => [ 'MediaConcurrency$Concurrency' => 'The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE
: Minimum value of 1. Maximum value of 1.
Valid Range for CHAT
: Minimum value of 1. Maximum value of 10.
Valid Range for TASK
: Minimum value of 1. Maximum value of 10.
Operation cannot be performed at this time as there is a conflict with another operation or contact state.
', 'refs' => [], ], 'ConnectionData' => [ 'base' => 'Information required to join the call.
', 'refs' => [ 'StartWebRTCContactResponse$ConnectionData' => 'Information required for the client application (mobile application or website) to connect to the call.
', ], ], 'Contact' => [ 'base' => 'Contains information about a contact.
', 'refs' => [ 'DescribeContactResponse$Contact' => 'Information about the contact.
', ], ], 'ContactAnalysis' => [ 'base' => 'A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
', 'refs' => [ 'SearchCriteria$ContactAnalysis' => 'Search criteria based on analysis outputs from Amazon Connect Contact Lens.
', ], ], 'ContactDataRequest' => [ 'base' => 'Request object with information to create a contact.
', 'refs' => [ 'ContactDataRequestList$member' => NULL, ], ], 'ContactDataRequestList' => [ 'base' => NULL, 'refs' => [ 'BatchPutContactRequest$ContactDataRequestList' => 'List of individual contact requests.
', ], ], 'ContactFilter' => [ 'base' => 'Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
', 'refs' => [ 'UserDataFilters$ContactFilter' => 'A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.
', ], ], 'ContactFlow' => [ 'base' => 'Contains information about a flow.
', 'refs' => [ 'ContactFlowSearchSummaryList$member' => NULL, 'DescribeContactFlowResponse$ContactFlow' => 'Information about the flow.
', ], ], 'ContactFlowContent' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
', 'CreateContactFlowRequest$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
', 'UpdateContactFlowContentRequest$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
', ], ], 'ContactFlowDescription' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Description' => 'The description of the flow.
', 'CreateContactFlowRequest$Description' => 'The description of the flow.
', 'UpdateContactFlowMetadataRequest$Description' => 'The description of the flow.
', 'UpdateContactFlowNameRequest$Description' => 'The description of the flow.
', ], ], 'ContactFlowId' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumberContactFlowRequest$ContactFlowId' => 'The identifier of the flow.
', 'ContactFlow$Id' => 'The identifier of the flow.
', 'ContactFlowSummary$Id' => 'The identifier of the flow.
', 'CreateContactFlowResponse$ContactFlowId' => 'The identifier of the flow.
', 'CreateTaskTemplateRequest$ContactFlowId' => 'The identifier of the flow that runs by default when a task is created by referencing this template.
', 'DeleteContactFlowRequest$ContactFlowId' => 'The identifier of the flow.
', 'DescribeContactFlowRequest$ContactFlowId' => 'The identifier of the flow.
', 'GetTaskTemplateResponse$ContactFlowId' => 'The identifier of the flow that runs by default when a task is created by referencing this template.
', 'OutboundCallerConfig$OutboundFlowId' => 'The outbound whisper flow to be used during an outbound call.
', 'PauseContactRequest$ContactFlowId' => 'The identifier of the flow.
', 'QueueQuickConnectConfig$ContactFlowId' => 'The identifier of the flow.
', 'ResumeContactRequest$ContactFlowId' => 'The identifier of the flow.
', 'StartChatContactRequest$ContactFlowId' => 'The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
', 'StartOutboundVoiceContactRequest$ContactFlowId' => 'The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
', 'StartTaskContactRequest$ContactFlowId' => 'The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
', 'StartWebRTCContactRequest$ContactFlowId' => 'The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
', 'TaskActionDefinition$ContactFlowId' => 'The identifier of the flow.
', 'TransferContactRequest$ContactFlowId' => 'The identifier of the flow.
', 'UpdateContactFlowContentRequest$ContactFlowId' => 'The identifier of the flow.
', 'UpdateContactFlowMetadataRequest$ContactFlowId' => 'The identifier of the flow.
', 'UpdateContactFlowNameRequest$ContactFlowId' => 'The identifier of the flow.
', 'UpdateTaskTemplateRequest$ContactFlowId' => 'The identifier of the flow that runs by default when a task is created by referencing this template.
', 'UpdateTaskTemplateResponse$ContactFlowId' => 'The identifier of the flow that runs by default when a task is created by referencing this template.
', 'UserQuickConnectConfig$ContactFlowId' => 'The identifier of the flow.
', ], ], 'ContactFlowModule' => [ 'base' => 'Contains information about a flow module.
', 'refs' => [ 'ContactFlowModuleSearchSummaryList$member' => NULL, 'DescribeContactFlowModuleResponse$ContactFlowModule' => 'Information about the flow module.
', ], ], 'ContactFlowModuleContent' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
', 'CreateContactFlowModuleRequest$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
', 'UpdateContactFlowModuleContentRequest$Content' => 'The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
', ], ], 'ContactFlowModuleDescription' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Description' => 'The description of the flow module.
', 'CreateContactFlowModuleRequest$Description' => 'The description of the flow module.
', 'UpdateContactFlowModuleMetadataRequest$Description' => 'The description of the flow module.
', ], ], 'ContactFlowModuleId' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Id' => 'The identifier of the flow module.
', 'ContactFlowModuleSummary$Id' => 'The identifier of the flow module.
', 'CreateContactFlowModuleResponse$Id' => 'The identifier of the flow module.
', 'DeleteContactFlowModuleRequest$ContactFlowModuleId' => 'The identifier of the flow module.
', 'DescribeContactFlowModuleRequest$ContactFlowModuleId' => 'The identifier of the flow module.
', 'UpdateContactFlowModuleContentRequest$ContactFlowModuleId' => 'The identifier of the flow module.
', 'UpdateContactFlowModuleMetadataRequest$ContactFlowModuleId' => 'The identifier of the flow module.
', ], ], 'ContactFlowModuleName' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Name' => 'The name of the flow module.
', 'ContactFlowModuleSummary$Name' => 'The name of the flow module.
', 'CreateContactFlowModuleRequest$Name' => 'The name of the flow module.
', 'UpdateContactFlowModuleMetadataRequest$Name' => 'The name of the flow module.
', ], ], 'ContactFlowModuleSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModuleSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return flow modules.
', 'refs' => [ 'ContactFlowModuleSearchConditionList$member' => NULL, 'SearchContactFlowModulesRequest$SearchCriteria' => 'The search criteria to be used to return contact flow modules.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
The search criteria to be used to return flow modules.
', 'refs' => [ 'SearchContactFlowModulesRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'ContactFlowModuleSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchContactFlowModulesResponse$ContactFlowModules' => 'The search criteria to be used to return contact flow modules.
', ], ], 'ContactFlowModuleState' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$State' => 'The type of flow module.
', 'ContactFlowModuleSummary$State' => 'The type of flow module.
', 'ListContactFlowModulesRequest$ContactFlowModuleState' => 'The state of the flow module.
', 'UpdateContactFlowModuleMetadataRequest$State' => 'The state of flow module.
', ], ], 'ContactFlowModuleStatus' => [ 'base' => NULL, 'refs' => [ 'ContactFlowModule$Status' => 'The status of the flow module.
', ], ], 'ContactFlowModuleSummary' => [ 'base' => 'Contains summary information about a flow.
', 'refs' => [ 'ContactFlowModulesSummaryList$member' => NULL, ], ], 'ContactFlowModulesSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListContactFlowModulesResponse$ContactFlowModulesSummaryList' => 'Information about the flow module.
', ], ], 'ContactFlowName' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Name' => 'The name of the flow.
', 'ContactFlowSummary$Name' => 'The name of the flow.
', 'CreateContactFlowRequest$Name' => 'The name of the flow.
', 'UpdateContactFlowMetadataRequest$Name' => 'The name of the flow.
', 'UpdateContactFlowNameRequest$Name' => 'The name of the flow.
', ], ], 'ContactFlowNotPublishedException' => [ 'base' => 'The flow has not been published.
', 'refs' => [], ], 'ContactFlowSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'ContactFlowSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return contact flows.
', 'refs' => [ 'ContactFlowSearchConditionList$member' => NULL, 'SearchContactFlowsRequest$SearchCriteria' => 'The search criteria to be used to return flows.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Filters to be applied to search results.
', 'refs' => [ 'SearchContactFlowsRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'ContactFlowSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchContactFlowsResponse$ContactFlows' => 'Information about the contact flows.
', ], ], 'ContactFlowState' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$State' => 'The type of flow.
', 'ContactFlowSearchCriteria$StateCondition' => 'The state of the flow.
', 'ContactFlowSummary$ContactFlowState' => 'The type of flow.
', 'UpdateContactFlowMetadataRequest$ContactFlowState' => 'The state of flow.
', ], ], 'ContactFlowStatus' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Status' => 'The status of the contact flow.
', 'ContactFlowSearchCriteria$StatusCondition' => 'The status of the flow.
', 'ContactFlowSummary$ContactFlowStatus' => 'The status of the contact flow.
', 'CreateContactFlowRequest$Status' => 'Indicates the flow status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content. the SAVED
status does not initiate validation of the content. SAVED
| PUBLISHED
.
Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
', 'refs' => [ 'ContactFlowSummaryList$member' => NULL, ], ], 'ContactFlowSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListContactFlowsResponse$ContactFlowSummaryList' => 'Information about the flows.
', ], ], 'ContactFlowType' => [ 'base' => NULL, 'refs' => [ 'ContactFlow$Type' => 'The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
', 'ContactFlowSearchCriteria$TypeCondition' => 'The type of flow.
', 'ContactFlowSummary$ContactFlowType' => 'The type of flow.
', 'ContactFlowTypes$member' => NULL, 'CreateContactFlowRequest$Type' => 'The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
', ], ], 'ContactFlowTypes' => [ 'base' => NULL, 'refs' => [ 'ListContactFlowsRequest$ContactFlowTypes' => 'The type of flow.
', ], ], 'ContactId' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'Contact$Id' => 'The identifier for the contact.
', 'Contact$InitialContactId' => 'If this contact is related to other contacts, this is the ID of the initial contact.
', 'Contact$PreviousContactId' => 'If this contact is not the first contact, this is the ID of the previous contact.
', 'Contact$RelatedContactId' => 'The contactId that is related to this contact.
', 'ContactSearchSummary$Id' => 'The identifier of the contact summary.
', 'ContactSearchSummary$InitialContactId' => 'If this contact is related to other contacts, this is the ID of the initial contact.
', 'ContactSearchSummary$PreviousContactId' => 'If this contact is not the first contact, this is the ID of the previous contact.
', 'CreateParticipantRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.
', 'CreatePersistentContactAssociationRequest$InitialContactId' => 'This is the contactId of the current contact that the CreatePersistentContactAssociation
API is being called from.
The contactId from which a persistent chat session must be started.
', 'CreatePersistentContactAssociationResponse$ContinuedFromContactId' => 'The contactId from which a persistent chat session is started. This field is populated only for persistent chat.
', 'DescribeContactRequest$ContactId' => 'The identifier of the contact.
', 'DismissUserContactRequest$ContactId' => 'The identifier of the contact.
', 'EvaluationMetadata$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'GetContactAttributesRequest$InitialContactId' => 'The identifier of the initial contact.
', 'ListContactEvaluationsRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'ListContactReferencesRequest$ContactId' => 'The identifier of the initial contact.
', 'ListRealtimeContactAnalysisSegmentsV2Request$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'MonitorContactRequest$ContactId' => 'The identifier of the contact.
', 'MonitorContactResponse$ContactId' => 'The identifier of the contact.
', 'PauseContactRequest$ContactId' => 'The identifier of the contact.
', 'PersistentChat$SourceContactId' => 'The contactId from which a persistent chat session must be started.
', 'ResumeContactRecordingRequest$ContactId' => 'The identifier of the contact.
', 'ResumeContactRecordingRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'ResumeContactRequest$ContactId' => 'The identifier of the contact.
', 'SendChatIntegrationEventResponse$InitialContactId' => 'Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact.
', 'StartChatContactRequest$RelatedContactId' => 'The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.
You cannot provide data for both RelatedContactId and PersistentChat.
The identifier of this contact within the Amazon Connect instance.
', 'StartChatContactResponse$ContinuedFromContactId' => 'The contactId from which a persistent chat session is started. This field is populated only for persistent chats.
', 'StartContactEvaluationRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'StartContactRecordingRequest$ContactId' => 'The identifier of the contact.
', 'StartContactRecordingRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'StartContactStreamingRequest$ContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'StartOutboundVoiceContactRequest$RelatedContactId' => 'The contactId
that is related to this contact. Linking voice, task, or chat by using RelatedContactID
copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId
.
The identifier of this contact within the Amazon Connect instance.
', 'StartTaskContactRequest$PreviousContactId' => 'The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID
will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.
The contactId that is related to this contact. Linking tasks together by using RelatedContactID
copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID
. There are no limits to the number of contacts that can be linked by using RelatedContactId
.
The identifier of this contact within the Amazon Connect instance.
', 'StartWebRTCContactRequest$RelatedContactId' => 'The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
', 'StartWebRTCContactResponse$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'StopContactRecordingRequest$ContactId' => 'The identifier of the contact.
', 'StopContactRecordingRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'StopContactRequest$ContactId' => 'The ID of the contact.
', 'StopContactStreamingRequest$ContactId' => 'The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.
', 'SuccessfulRequest$ContactId' => 'The contactId of the contact that was created successfully.
', 'SuspendContactRecordingRequest$ContactId' => 'The identifier of the contact.
', 'SuspendContactRecordingRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'TagContactRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'TransferContactRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'TransferContactResponse$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'UntagContactRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'UpdateContactAttributesRequest$InitialContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
', 'UpdateContactRequest$ContactId' => 'The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
', 'UpdateContactRoutingDataRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', 'UpdateContactScheduleRequest$ContactId' => 'The identifier of the contact.
', 'UpdateParticipantRoleConfigRequest$ContactId' => 'The identifier of the contact in this instance of Amazon Connect.
', ], ], 'ContactInitiationMethod' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$InitiationMethod' => 'How the contact was initiated.
', 'Contact$InitiationMethod' => 'Indicates how the contact was initiated.
', 'ContactSearchSummary$InitiationMethod' => 'Indicates how the contact was initiated.
', 'InitiationMethodList$member' => NULL, ], ], 'ContactNotFoundException' => [ 'base' => 'The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
', 'refs' => [], ], 'ContactReferences' => [ 'base' => NULL, 'refs' => [ 'StartOutboundVoiceContactRequest$References' => 'A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during voice contact creation.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during task creation.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL
| NUMBER
| STRING
| DATE
| EMAIL
. ATTACHMENT
is not a supported reference type during task creation.
Information about the reference when the referenceType
is URL
. Otherwise, null. (Supports variable injection in the Value
field.)
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
', ], ], 'ContactSearchSummary' => [ 'base' => 'Information of returned contact.
', 'refs' => [ 'Contacts$member' => NULL, ], ], 'ContactSearchSummaryAgentInfo' => [ 'base' => 'Information about the agent who accepted the contact.
', 'refs' => [ 'ContactSearchSummary$AgentInfo' => 'Information about the agent who accepted the contact.
', ], ], 'ContactSearchSummaryQueueInfo' => [ 'base' => 'If this contact was queued, this contains information about the queue.
', 'refs' => [ 'ContactSearchSummary$QueueInfo' => 'If this contact was queued, this contains information about the queue.
', ], ], 'ContactState' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$AgentContactState' => 'The state of the contact.
When AgentContactState
is set to CONNECTED_ONHOLD
, StateStartTimestamp
is not changed. Instead, StateStartTimestamp
reflects the time the contact was CONNECTED
to the agent.
A list of up to 9 contact states.
', ], ], 'ContactTagKey' => [ 'base' => NULL, 'refs' => [ 'ContactTagKeys$member' => NULL, 'ContactTagMap$key' => NULL, ], ], 'ContactTagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagContactRequest$TagKeys' => 'A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.
', ], ], 'ContactTagMap' => [ 'base' => NULL, 'refs' => [ 'Contact$Tags' => 'Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
', 'TagContactRequest$Tags' => 'The tags to be assigned to the contact resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Authorization is not supported by this tag.
Information about the contacts.
', ], ], 'Content' => [ 'base' => NULL, 'refs' => [ 'SendNotificationActionDefinition$Content' => 'Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisAttachment$ContentType' => 'Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
', ], ], 'ControlPlaneTagFilter' => [ 'base' => 'An object that can be used to specify Tag conditions inside the SearchFilter
. This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
operator
Inner list specifies conditions that need to be applied with AND
operator.
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter
.
This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
operator
The inner list specifies conditions that need to be applied with AND
operator.
Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum number of allowed Hierarchy Group conditions is 20.
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.
This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
operator.
The inner list specifies conditions that need to be applied with AND
operator.
Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.
The CreateCase
action definition.
Information about the create case action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnPostChatAnalysisAvailable
.
The name of the security profile.
', ], ], 'CreateSecurityProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSecurityProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTaskTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTaskTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrafficDistributionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTrafficDistributionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUseCaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUseCaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserHierarchyGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserHierarchyGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateViewRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateViewResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateViewVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateViewVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVocabularyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVocabularyResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedByInfo' => [ 'base' => 'Information on the identity that created the file.
', 'refs' => [ 'AttachedFile$CreatedBy' => 'Represents the identity that created the file.
', 'GetAttachedFileResponse$CreatedBy' => 'Represents the identity that created the file.
', 'StartAttachedFileUploadRequest$CreatedBy' => 'Represents the identity that created the file.
', 'StartAttachedFileUploadResponse$CreatedBy' => 'Represents the identity that created the file.
', ], ], 'Credentials' => [ 'base' => 'Contains credentials to use for federation.
', 'refs' => [ 'GetFederationTokenResponse$Credentials' => 'The credentials to use for federation.
', ], ], 'CrossChannelBehavior' => [ 'base' => 'Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.
', 'refs' => [ 'MediaConcurrency$CrossChannelBehavior' => 'Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.
', ], ], 'CurrentMetric' => [ 'base' => 'Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
', 'refs' => [ 'CurrentMetricData$Metric' => 'Information about the metric.
', 'CurrentMetrics$member' => NULL, ], ], 'CurrentMetricData' => [ 'base' => 'Contains the data for a real-time metric.
', 'refs' => [ 'CurrentMetricDataCollections$member' => NULL, ], ], 'CurrentMetricDataCollections' => [ 'base' => NULL, 'refs' => [ 'CurrentMetricResult$Collections' => 'The set of metrics.
', ], ], 'CurrentMetricName' => [ 'base' => 'The current metric names.
', 'refs' => [ 'CurrentMetric$Name' => 'The name of the metric.
', 'CurrentMetricSortCriteria$SortByMetric' => NULL, ], ], 'CurrentMetricResult' => [ 'base' => 'Contains information about a set of real-time metrics.
', 'refs' => [ 'CurrentMetricResults$member' => NULL, ], ], 'CurrentMetricResults' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataResponse$MetricResults' => 'Information about the real-time metrics.
', ], ], 'CurrentMetricSortCriteria' => [ 'base' => 'The way to sort the resulting response based on metrics. By default resources are sorted based on AGENTS_ONLINE
, DESCENDING
. The metric collection is sorted based on the input metrics.
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE
, DESCENDING
. The metric collection is sorted based on the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE
and SLOTS_AVAILABLE
is not supported.
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
}
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression
is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1>
for 10 seconds has expired and <Expression 2>
becomes active, then OLDEST_CONTACT_AGE
for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
Information about the Customer on the contact.
', 'refs' => [ 'Contact$Customer' => 'Information about the Customer on the contact.
', ], ], 'CustomerQualityMetrics' => [ 'base' => 'Information about the quality of the Customer\'s media connection
', 'refs' => [ 'QualityMetrics$Customer' => 'Information about the quality of Customer media connection.
', ], ], 'CustomerVoiceActivity' => [ 'base' => 'Information about customer’s voice activity.
', 'refs' => [ 'Contact$CustomerVoiceActivity' => 'Information about customer’s voice activity.
', ], ], 'DataSetId' => [ 'base' => NULL, 'refs' => [ 'AnalyticsDataAssociationResult$DataSetId' => 'The identifier of the dataset.
', 'AssociateAnalyticsDataSetRequest$DataSetId' => 'The identifier of the dataset to associate with the target account.
', 'AssociateAnalyticsDataSetResponse$DataSetId' => 'The identifier of the dataset that was associated.
', 'DataSetIds$member' => NULL, 'DisassociateAnalyticsDataSetRequest$DataSetId' => 'The identifier of the dataset to remove.
', 'ListAnalyticsDataAssociationsRequest$DataSetId' => 'The identifier of the dataset to get the association status.
', ], ], 'DataSetIds' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateAnalyticsDataSetRequest$DataSetIds' => 'An array of dataset identifiers to associate.
', 'BatchDisassociateAnalyticsDataSetRequest$DataSetIds' => 'An array of associated dataset identifiers to remove.
', 'BatchDisassociateAnalyticsDataSetResponse$Deleted' => 'An array of successfully disassociated dataset identifiers.
', ], ], 'DateReference' => [ 'base' => 'Information about a reference when the referenceType
is DATE
. Otherwise, null.
Information about a reference when the referenceType
is DATE
. Otherwise, null.
Contains information about a default vocabulary.
', 'refs' => [ 'DefaultVocabularyList$member' => NULL, ], ], 'DefaultVocabularyList' => [ 'base' => NULL, 'refs' => [ 'ListDefaultVocabulariesResponse$DefaultVocabularyList' => 'A list of default vocabularies.
', ], ], 'Delay' => [ 'base' => NULL, 'refs' => [ 'RoutingProfileQueueConfig$Delay' => 'The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.
', 'RoutingProfileQueueConfigSummary$Delay' => 'The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.
', ], ], 'DeleteAttachedFileRequest' => [ 'base' => 'Request to DeleteAttachedFile API', 'refs' => [], ], 'DeleteAttachedFileResponse' => [ 'base' => 'Response from DeleteAttachedFile API', 'refs' => [], ], 'DeleteContactEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactFlowModuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactFlowModuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEvaluationFormRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHoursOfOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIntegrationAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePredefinedAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePromptRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteQueueRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteQuickConnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRoutingProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTaskTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrafficDistributionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTrafficDistributionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUseCaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserHierarchyGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteViewRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteViewResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteViewVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteViewVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVocabularyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVocabularyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAgentStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAgentStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactFlowModuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactFlowModuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEvaluationFormRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEvaluationFormResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHoursOfOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHoursOfOperationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceAttributeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceStorageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInstanceStorageConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePredefinedAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePredefinedAttributeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribePromptRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribePromptResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQueueRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQueueResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQuickConnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeQuickConnectResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRoutingProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRoutingProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrafficDistributionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTrafficDistributionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserHierarchyGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserHierarchyGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserHierarchyStructureRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserHierarchyStructureResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeViewRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeViewResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVocabularyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVocabularyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'Contact$Description' => 'The description of the contact.
', 'StartOutboundVoiceContactRequest$Description' => 'A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
', 'StartTaskContactRequest$Description' => 'A description of the task that is shown to an agent in the Contact Control Panel (CCP).
', 'StartWebRTCContactRequest$Description' => 'A description of the task that is shown to an agent in the Contact Control Panel (CCP).
', 'UpdateContactRequest$Description' => 'The description of the contact.
', ], ], 'Description250' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupRequest$Description' => 'A description for the traffic distribution group.
', 'TrafficDistributionGroup$Description' => 'The description of the traffic distribution group.
', ], ], 'DestinationId' => [ 'base' => NULL, 'refs' => [ 'SendChatIntegrationEventRequest$DestinationId' => 'Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.
', ], ], 'DestinationNotAllowedException' => [ 'base' => 'Outbound calls to the destination number are not allowed.
', 'refs' => [], ], 'DeviceInfo' => [ 'base' => 'Information regarding the device.
', 'refs' => [ 'AgentInfo$DeviceInfo' => 'Information regarding Agent’s device.
', 'Customer$DeviceInfo' => 'Information regarding Customer’s device.
', ], ], 'Dimensions' => [ 'base' => 'Contains information about the dimensions for a set of metrics.
', 'refs' => [ 'CurrentMetricResult$Dimensions' => 'The dimensions for the metrics.
', 'HistoricalMetricResult$Dimensions' => 'The dimension for the metrics.
', ], ], 'DimensionsV2Key' => [ 'base' => NULL, 'refs' => [ 'DimensionsV2Map$key' => NULL, ], ], 'DimensionsV2Map' => [ 'base' => NULL, 'refs' => [ 'MetricResultV2$Dimensions' => 'The dimension for the metrics.
', ], ], 'DimensionsV2Value' => [ 'base' => NULL, 'refs' => [ 'DimensionsV2Map$value' => NULL, ], ], 'DirectoryAlias' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceRequest$InstanceAlias' => 'The name for your instance.
', 'Instance$InstanceAlias' => 'The alias of instance.
', 'InstanceSummary$InstanceAlias' => 'The alias of the instance.
', 'ReplicateInstanceRequest$ReplicaAlias' => 'The alias for the replicated instance. The ReplicaAlias
must be unique.
The identifier for the directory.
', ], ], 'DirectoryType' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceRequest$IdentityManagementType' => 'The type of identity management for your Amazon Connect users.
', 'Instance$IdentityManagementType' => 'The identity management type.
', 'InstanceSummary$IdentityManagementType' => 'The identity management type of the instance.
', ], ], 'DirectoryUserId' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$DirectoryUserId' => 'The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.
This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
', 'User$DirectoryUserId' => 'The identifier of the user account in the directory used for identity management.
', 'UserSearchSummary$DirectoryUserId' => 'The directory identifier of the user.
', ], ], 'DisassociateAnalyticsDataSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateApprovedOriginRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateBotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateInstanceStorageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateLambdaFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateLexBotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociatePhoneNumberContactFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateQueueQuickConnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateRoutingProfileQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateSecurityKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTrafficDistributionGroupUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTrafficDistributionGroupUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateUserProficienciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisconnectDetails' => [ 'base' => 'Information about the call disconnect experience.
', 'refs' => [ 'Contact$DisconnectDetails' => 'Information about the call disconnect experience.
', ], ], 'DisconnectReason' => [ 'base' => 'Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
', 'refs' => [ 'StopContactRequest$DisconnectReason' => 'The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field.
', ], ], 'DisconnectReasonCode' => [ 'base' => NULL, 'refs' => [ 'DisconnectReason$Code' => 'A code that indicates how the contact was terminated.
', ], ], 'DismissUserContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DismissUserContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisplayName' => [ 'base' => NULL, 'refs' => [ 'ParticipantDetails$DisplayName' => 'Display name of the participant.
', 'ParticipantDetailsToAdd$DisplayName' => 'The display name of the participant.
', 'RealTimeContactAnalysisSegmentAttachments$DisplayName' => 'The display name of the participant. Can be redacted.
', 'RealTimeContactAnalysisSegmentEvent$DisplayName' => 'The display name of the participant. Can be redacted.
', 'RealTimeContactAnalysisSegmentTranscript$DisplayName' => 'The display name of the participant.
', ], ], 'Distribution' => [ 'base' => 'Information about a traffic distribution.
', 'refs' => [ 'DistributionList$member' => NULL, ], ], 'DistributionList' => [ 'base' => NULL, 'refs' => [ 'AgentConfig$Distributions' => 'Information about traffic distributions.
', 'TelephonyConfig$Distributions' => 'Information about traffic distributions.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'FieldValueUnion$DoubleValue' => 'A Double number value type.
', ], ], 'DownloadUrlMetadata' => [ 'base' => 'Metadata used to download the attached file.
', 'refs' => [ 'GetAttachedFileResponse$DownloadUrlMetadata' => 'URL and expiry to be used when downloading the attached file.
', ], ], 'DuplicateResourceException' => [ 'base' => 'A resource with the specified name already exists.
', 'refs' => [], ], 'DurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Expiry$DurationInSeconds' => 'The number of seconds to wait before expiring the routing step.
', ], ], 'Email' => [ 'base' => NULL, 'refs' => [ 'UserIdentityInfo$Email' => 'The email address. If you are using SAML for identity management and include this parameter, an error is returned.
', 'UserIdentityInfo$SecondaryEmail' => 'The user\'s secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.
Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}
Information about a reference when the referenceType
is EMAIL
. Otherwise, null.
Information about a reference when the referenceType
is EMAIL
. Otherwise, null.
An empty value.
', 'refs' => [ 'FieldValueUnion$EmptyValue' => 'An empty value.
', ], ], 'EncryptionConfig' => [ 'base' => 'The encryption configuration.
', 'refs' => [ 'KinesisVideoStreamConfig$EncryptionConfig' => 'The encryption configuration.
', 'S3Config$EncryptionConfig' => 'The Amazon S3 encryption configuration.
', ], ], 'EncryptionType' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfig$EncryptionType' => 'The type of encryption.
', ], ], 'EndAssociatedTasksActionDefinition' => [ 'base' => 'End associated tasks related to a case.
', 'refs' => [ 'RuleAction$EndAssociatedTasksAction' => 'Information about the end associated tasks action.
Supported only for TriggerEventSource
values: OnCaseUpdate
.
Information about the endpoint.
', 'refs' => [ 'ContactDataRequest$SystemEndpoint' => 'Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.
', 'ContactDataRequest$CustomerEndpoint' => 'Endpoint of the customer for which contact will be initiated.
', ], ], 'EndpointAddress' => [ 'base' => NULL, 'refs' => [ 'Endpoint$Address' => 'Address of the endpoint.
', ], ], 'EndpointType' => [ 'base' => NULL, 'refs' => [ 'Endpoint$Type' => 'Type of the endpoint.
', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'AttachedFileError$ErrorCode' => 'Status code describing the failure.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AttachedFileError$ErrorMessage' => 'Why the attached file couldn\'t be retrieved.
', ], ], 'ErrorResult' => [ 'base' => 'This API is in preview release for Amazon Connect and is subject to change.
List of errors for dataset association failures.
', 'refs' => [ 'ErrorResults$member' => NULL, ], ], 'ErrorResults' => [ 'base' => NULL, 'refs' => [ 'BatchAssociateAnalyticsDataSetResponse$Errors' => 'A list of errors for datasets that aren\'t successfully associated with the target account.
', 'BatchDisassociateAnalyticsDataSetResponse$Errors' => 'A list of errors for any datasets not successfully removed.
', ], ], 'Evaluation' => [ 'base' => 'Information about a contact evaluation.
', 'refs' => [ 'DescribeContactEvaluationResponse$Evaluation' => 'Information about the evaluation form completed for a specific contact.
', ], ], 'EvaluationAnswerData' => [ 'base' => 'Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
', 'refs' => [ 'EvaluationAnswerInput$Value' => 'The value for an answer in a contact evaluation.
', 'EvaluationAnswerOutput$Value' => 'The value for an answer in a contact evaluation.
', 'EvaluationAnswerOutput$SystemSuggestedValue' => 'The system suggested value for an answer in a contact evaluation.
', ], ], 'EvaluationAnswerDataNumericValue' => [ 'base' => NULL, 'refs' => [ 'EvaluationAnswerData$NumericValue' => 'The numeric value for an answer in a contact evaluation.
', ], ], 'EvaluationAnswerDataStringValue' => [ 'base' => NULL, 'refs' => [ 'EvaluationAnswerData$StringValue' => 'The string value for an answer in a contact evaluation.
', ], ], 'EvaluationAnswerInput' => [ 'base' => 'Information about input answers for a contact evaluation.
', 'refs' => [ 'EvaluationAnswersInputMap$value' => NULL, ], ], 'EvaluationAnswerOutput' => [ 'base' => 'Information about output answers for a contact evaluation.
', 'refs' => [ 'EvaluationAnswersOutputMap$value' => NULL, ], ], 'EvaluationAnswersInputMap' => [ 'base' => NULL, 'refs' => [ 'SubmitContactEvaluationRequest$Answers' => 'A map of question identifiers to answer value.
', 'UpdateContactEvaluationRequest$Answers' => 'A map of question identifiers to answer value.
', ], ], 'EvaluationAnswersOutputMap' => [ 'base' => NULL, 'refs' => [ 'Evaluation$Answers' => 'A map of question identifiers to answer value.
', ], ], 'EvaluationForm' => [ 'base' => 'Information about the evaluation form.
', 'refs' => [ 'DescribeEvaluationFormResponse$EvaluationForm' => 'Information about the evaluation form.
', ], ], 'EvaluationFormContent' => [ 'base' => 'Information about an evaluation form used in a contact evaluation.
', 'refs' => [ 'DescribeContactEvaluationResponse$EvaluationForm' => 'Information about the evaluation form.
', ], ], 'EvaluationFormDescription' => [ 'base' => NULL, 'refs' => [ 'CreateEvaluationFormRequest$Description' => 'The description of the evaluation form.
', 'EvaluationForm$Description' => 'The description of the evaluation form.
', 'EvaluationFormContent$Description' => 'The description of the evaluation form.
', 'UpdateEvaluationFormRequest$Description' => 'The description of the evaluation form.
', ], ], 'EvaluationFormId' => [ 'base' => NULL, 'refs' => [ 'SubmitAutoEvaluationActionDefinition$EvaluationFormId' => 'The identifier of the auto-evaluation enabled form.
', ], ], 'EvaluationFormItem' => [ 'base' => 'Information about an item from an evaluation form. The item must be either a section or a question.
', 'refs' => [ 'EvaluationFormItemsList$member' => NULL, ], ], 'EvaluationFormItemWeight' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$Weight' => 'The scoring weight of the section.
', 'EvaluationFormSection$Weight' => 'The scoring weight of the section.
', ], ], 'EvaluationFormItemsList' => [ 'base' => NULL, 'refs' => [ 'CreateEvaluationFormRequest$Items' => 'Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
', 'EvaluationForm$Items' => 'Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
', 'EvaluationFormContent$Items' => 'Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
', 'EvaluationFormSection$Items' => 'The items of the section.
', 'UpdateEvaluationFormRequest$Items' => 'Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
', ], ], 'EvaluationFormNumericQuestionAutomation' => [ 'base' => 'Information about the automation configuration in numeric questions.
', 'refs' => [ 'EvaluationFormNumericQuestionProperties$Automation' => 'The automation properties of the numeric question.
', ], ], 'EvaluationFormNumericQuestionOption' => [ 'base' => 'Information about the option range used for scoring in numeric questions.
', 'refs' => [ 'EvaluationFormNumericQuestionOptionList$member' => NULL, ], ], 'EvaluationFormNumericQuestionOptionList' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormNumericQuestionProperties$Options' => 'The scoring options of the numeric question.
', ], ], 'EvaluationFormNumericQuestionProperties' => [ 'base' => 'Information about properties for a numeric question in an evaluation form.
', 'refs' => [ 'EvaluationFormQuestionTypeProperties$Numeric' => 'The properties of the numeric question.
', ], ], 'EvaluationFormQuestion' => [ 'base' => 'Information about a question from an evaluation form.
', 'refs' => [ 'EvaluationFormItem$Question' => 'The information of the question.
', ], ], 'EvaluationFormQuestionAnswerScore' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormNumericQuestionOption$Score' => 'The score assigned to answer values within the range option.
', 'EvaluationFormSingleSelectQuestionOption$Score' => 'The score assigned to the answer option.
', ], ], 'EvaluationFormQuestionInstructions' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$Instructions' => 'The instructions of the section.
', 'EvaluationFormSection$Instructions' => 'The instructions of the section.
', ], ], 'EvaluationFormQuestionTitle' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$Title' => 'The title of the question.
', ], ], 'EvaluationFormQuestionType' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$QuestionType' => 'The type of the question.
', ], ], 'EvaluationFormQuestionTypeProperties' => [ 'base' => 'Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.
', 'refs' => [ 'EvaluationFormQuestion$QuestionTypeProperties' => 'The properties of the type of question. Text questions do not have to define question type properties.
', ], ], 'EvaluationFormScoringMode' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormScoringStrategy$Mode' => 'The scoring mode of the evaluation form.
', ], ], 'EvaluationFormScoringStatus' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormScoringStrategy$Status' => 'The scoring status of the evaluation form.
', ], ], 'EvaluationFormScoringStrategy' => [ 'base' => 'Information about scoring strategy for an evaluation form.
', 'refs' => [ 'CreateEvaluationFormRequest$ScoringStrategy' => 'A scoring strategy of the evaluation form.
', 'EvaluationForm$ScoringStrategy' => 'A scoring strategy of the evaluation form.
', 'EvaluationFormContent$ScoringStrategy' => 'A scoring strategy of the evaluation form.
', 'UpdateEvaluationFormRequest$ScoringStrategy' => 'A scoring strategy of the evaluation form.
', ], ], 'EvaluationFormSection' => [ 'base' => 'Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).
', 'refs' => [ 'EvaluationFormItem$Section' => 'The information of the section.
', ], ], 'EvaluationFormSectionTitle' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSection$Title' => 'The title of the section.
', ], ], 'EvaluationFormSingleSelectQuestionAutomation' => [ 'base' => 'Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.
', 'refs' => [ 'EvaluationFormSingleSelectQuestionProperties$Automation' => 'The display mode of the single select question.
', ], ], 'EvaluationFormSingleSelectQuestionAutomationOption' => [ 'base' => 'Information about the automation option of a single select question.
', 'refs' => [ 'EvaluationFormSingleSelectQuestionAutomationOptionList$member' => NULL, ], ], 'EvaluationFormSingleSelectQuestionAutomationOptionList' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSingleSelectQuestionAutomation$Options' => 'The automation options of the single select question.
', ], ], 'EvaluationFormSingleSelectQuestionDisplayMode' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSingleSelectQuestionProperties$DisplayAs' => 'The display mode of the single select question.
', ], ], 'EvaluationFormSingleSelectQuestionOption' => [ 'base' => 'Information about the automation configuration in single select questions.
', 'refs' => [ 'EvaluationFormSingleSelectQuestionOptionList$member' => NULL, ], ], 'EvaluationFormSingleSelectQuestionOptionList' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSingleSelectQuestionProperties$Options' => 'The answer options of the single select question.
', ], ], 'EvaluationFormSingleSelectQuestionOptionText' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormSingleSelectQuestionOption$Text' => 'The title of the answer option.
', ], ], 'EvaluationFormSingleSelectQuestionProperties' => [ 'base' => 'Information about the options in single select questions.
', 'refs' => [ 'EvaluationFormQuestionTypeProperties$SingleSelect' => 'The properties of the numeric question.
', ], ], 'EvaluationFormSummary' => [ 'base' => 'Summary information about an evaluation form.
', 'refs' => [ 'EvaluationFormSummaryList$member' => NULL, ], ], 'EvaluationFormSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEvaluationFormsResponse$EvaluationFormSummaryList' => 'Provides details about a list of evaluation forms belonging to an instance.
', ], ], 'EvaluationFormTitle' => [ 'base' => NULL, 'refs' => [ 'CreateEvaluationFormRequest$Title' => 'A title of the evaluation form.
', 'EvaluationForm$Title' => 'A title of the evaluation form.
', 'EvaluationFormContent$Title' => 'A title of the evaluation form.
', 'EvaluationFormSummary$Title' => 'A title of the evaluation form.
', 'EvaluationSummary$EvaluationFormTitle' => 'A title of the evaluation form.
', 'UpdateEvaluationFormRequest$Title' => 'A title of the evaluation form.
', ], ], 'EvaluationFormVersionIsLocked' => [ 'base' => NULL, 'refs' => [ 'EvaluationForm$Locked' => 'The flag indicating whether the evaluation form is locked for changes.
', 'EvaluationFormVersionSummary$Locked' => 'The flag indicating whether the evaluation form is locked for changes.
', ], ], 'EvaluationFormVersionStatus' => [ 'base' => NULL, 'refs' => [ 'EvaluationForm$Status' => 'The status of the evaluation form.
', 'EvaluationFormVersionSummary$Status' => 'The status of the evaluation form.
', ], ], 'EvaluationFormVersionSummary' => [ 'base' => 'Summary information about an evaluation form.
', 'refs' => [ 'EvaluationFormVersionSummaryList$member' => NULL, ], ], 'EvaluationFormVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListEvaluationFormVersionsResponse$EvaluationFormVersionSummaryList' => 'Provides details about a list of evaluation forms belonging to an instance.
', ], ], 'EvaluationMetadata' => [ 'base' => 'Metadata information about a contact evaluation.
', 'refs' => [ 'Evaluation$Metadata' => 'Metadata about the contact evaluation.
', ], ], 'EvaluationNote' => [ 'base' => 'Information about notes for a contact evaluation.
', 'refs' => [ 'EvaluationNotesMap$value' => NULL, ], ], 'EvaluationNoteString' => [ 'base' => NULL, 'refs' => [ 'EvaluationNote$Value' => 'The note for an item (section or question) in a contact evaluation.
Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.
A map of question identifiers to note value.
', 'SubmitContactEvaluationRequest$Notes' => 'A map of question identifiers to note value.
', 'UpdateContactEvaluationRequest$Notes' => 'A map of question identifiers to note value.
', ], ], 'EvaluationScore' => [ 'base' => 'Information about scores of a contact evaluation item (section or question).
', 'refs' => [ 'EvaluationMetadata$Score' => 'The overall score of the contact evaluation.
', 'EvaluationScoresMap$value' => NULL, 'EvaluationSummary$Score' => 'The overall score of the contact evaluation.
', ], ], 'EvaluationScorePercentage' => [ 'base' => NULL, 'refs' => [ 'EvaluationScore$Percentage' => 'The score percentage for an item in a contact evaluation.
', ], ], 'EvaluationScoresMap' => [ 'base' => NULL, 'refs' => [ 'Evaluation$Scores' => 'A map of item (section or question) identifiers to score value.
', ], ], 'EvaluationStatus' => [ 'base' => NULL, 'refs' => [ 'Evaluation$Status' => 'The status of the contact evaluation.
', 'EvaluationSummary$Status' => 'The status of the contact evaluation.
', ], ], 'EvaluationSummary' => [ 'base' => 'Summary information about a contact evaluation.
', 'refs' => [ 'EvaluationSummaryList$member' => NULL, ], ], 'EvaluationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListContactEvaluationsResponse$EvaluationSummaryList' => 'Provides details about a list of contact evaluations belonging to an instance.
', ], ], 'EventBridgeActionDefinition' => [ 'base' => 'The EventBridge action definition.
', 'refs' => [ 'RuleAction$EventBridgeAction' => 'Information about the EventBridge action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
The name.
', ], ], 'EventSourceName' => [ 'base' => NULL, 'refs' => [ 'ListRulesRequest$EventSourceName' => 'The name of the event source.
', 'RuleSummary$EventSourceName' => 'The name of the event source.
', 'RuleTriggerEventSource$EventSourceName' => 'The name of the event source.
', ], ], 'Expiry' => [ 'base' => 'An object to specify the expiration of a routing step.
', 'refs' => [ 'Step$Expiry' => 'An object to specify the expiration of a routing step.
', ], ], 'Expression' => [ 'base' => 'A tagged union to specify expression for a routing step.
', 'refs' => [ 'Expressions$member' => NULL, 'Step$Expression' => 'A tagged union to specify expression for a routing step.
', ], ], 'Expressions' => [ 'base' => NULL, 'refs' => [ 'Expression$AndExpression' => 'List of routing expressions which will be AND-ed together.
', 'Expression$OrExpression' => 'List of routing expressions which will be OR-ed together.
', ], ], 'FailedRequest' => [ 'base' => 'Request for which contact failed to be generated.
', 'refs' => [ 'FailedRequestList$member' => NULL, ], ], 'FailedRequestList' => [ 'base' => NULL, 'refs' => [ 'BatchPutContactResponse$FailedRequestList' => 'List of requests for which contact creation failed.
', ], ], 'FailureReasonCode' => [ 'base' => NULL, 'refs' => [ 'FailedRequest$FailureReasonCode' => 'Reason code for the failure.
', ], ], 'FieldStringValue' => [ 'base' => NULL, 'refs' => [ 'FieldValueUnion$StringValue' => 'String value type.
', ], ], 'FieldValue' => [ 'base' => 'Object for case field values.
', 'refs' => [ 'FieldValues$member' => NULL, ], ], 'FieldValueId' => [ 'base' => NULL, 'refs' => [ 'FieldValue$Id' => 'Unique identifier of a field.
', ], ], 'FieldValueUnion' => [ 'base' => 'Object to store union of Field values.
', 'refs' => [ 'FieldValue$Value' => 'Union of potential field value types.
', ], ], 'FieldValues' => [ 'base' => NULL, 'refs' => [ 'CreateCaseActionDefinition$Fields' => 'An array of objects with Field ID
and Value
data.
An array of objects with Field ID
and Value data.
The unique identifier of the attached file resource.
', 'AttachedFileError$FileId' => 'The unique identifier of the attached file resource.
', 'CompleteAttachedFileUploadRequest$FileId' => 'The unique identifier of the attached file resource.
', 'DeleteAttachedFileRequest$FileId' => 'The unique identifier of the attached file resource.
', 'FileIdList$member' => NULL, 'GetAttachedFileRequest$FileId' => 'The unique identifier of the attached file resource.
', 'GetAttachedFileResponse$FileId' => 'The unique identifier of the attached file resource.
', 'StartAttachedFileUploadResponse$FileId' => 'The unique identifier of the attached file resource.
', ], ], 'FileIdList' => [ 'base' => NULL, 'refs' => [ 'BatchGetAttachedFileMetadataRequest$FileIds' => 'The unique identifiers of the attached file resource.
', ], ], 'FileName' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$FileName' => 'A case-sensitive name of the attached file being uploaded.
', 'GetAttachedFileResponse$FileName' => 'A case-sensitive name of the attached file being uploaded.
', 'StartAttachedFileUploadRequest$FileName' => 'A case-sensitive name of the attached file being uploaded.
', ], ], 'FileSizeInBytes' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$FileSizeInBytes' => 'The size of the attached file in bytes.
', 'GetAttachedFileResponse$FileSizeInBytes' => 'The size of the attached file in bytes.
', 'StartAttachedFileUploadRequest$FileSizeInBytes' => 'The size of the attached file in bytes.
', ], ], 'FileStatusType' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$FileStatus' => 'The current status of the attached file.
', 'GetAttachedFileResponse$FileStatus' => 'The current status of the attached file.
', 'StartAttachedFileUploadResponse$FileStatus' => 'The current status of the attached file.
', ], ], 'FileUseCaseType' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$FileUseCaseType' => 'The use case for the file.
', 'GetAttachedFileResponse$FileUseCaseType' => 'The use case for the file.
', 'StartAttachedFileUploadRequest$FileUseCaseType' => 'The use case for the file.
', ], ], 'FilterV2' => [ 'base' => 'Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
', 'refs' => [ 'FiltersV2List$member' => NULL, ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'FilterV2$FilterValues' => 'The identifiers to use for filtering data. For example, if you have a filter key of QUEUE
, you would add queue IDs or ARNs in FilterValues
.
Contains the filter to apply when retrieving metrics.
', 'refs' => [ 'GetCurrentMetricDataRequest$Filters' => 'The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
RoutingStepExpressions: 50
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
When using the RoutingStepExpression
filter, you need to pass exactly one QueueId
. The filter is also case sensitive so when using the RoutingStepExpression
filter, grouping by ROUTING_STEP_EXPRESSION
is required.
Currently tagging is only supported on the resources that are passed in the filter.
', 'GetMetricDataRequest$Filters' => 'The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
The filters to apply to returned metrics. You can filter on the following resources:
Agents
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT
| AGENT_HIERARCHY_LEVEL_ONE
| AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
| CASE_TEMPLATE_ARN
| CASE_STATUS
| CHANNEL
| contact/segmentAttributes/connect:Subtype
| FEATURE
| FLOW_TYPE
| FLOWS_NEXT_RESOURCE_ID
| FLOWS_NEXT_RESOURCE_QUEUE_ID
| FLOWS_OUTCOME_TYPE
| FLOWS_RESOURCE_ID
| INITIATION_METHOD
| RESOURCE_PUBLISHED_TIMESTAMP
| ROUTING_PROFILE
| ROUTING_STEP_EXPRESSION
| QUEUE
| Q_CONNECT_ENABLED
|
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics
is a valid filterValue for the FEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat
, connect:SMS
, connect:Telephony
, and connect:WebRTC
are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter
key.
ROUTING_STEP_EXPRESSION
is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
Q_CONNECT_ENABLED
. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED
filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
A valid resource type.
', 'DisassociateFlowRequest$ResourceType' => 'A valid resource type.
', 'GetFlowAssociationRequest$ResourceType' => 'A valid resource type.
', 'GetFlowAssociationResponse$ResourceType' => 'A valid resource type.
', ], ], 'FlowAssociationSummary' => [ 'base' => 'Information about flow associations.
', 'refs' => [ 'FlowAssociationSummaryList$member' => NULL, ], ], 'FlowAssociationSummaryList' => [ 'base' => NULL, 'refs' => [ 'BatchGetFlowAssociationResponse$FlowAssociationSummaryList' => 'Information about flow associations.
', 'ListFlowAssociationsResponse$FlowAssociationSummaryList' => 'Summary of flow associations.
', ], ], 'FunctionArn' => [ 'base' => NULL, 'refs' => [ 'AssociateLambdaFunctionRequest$FunctionArn' => 'The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
', 'DisassociateLambdaFunctionRequest$FunctionArn' => 'The Amazon Resource Name (ARN) of the Lambda function being disassociated.
', 'FunctionArnsList$member' => NULL, ], ], 'FunctionArnsList' => [ 'base' => NULL, 'refs' => [ 'ListLambdaFunctionsResponse$LambdaFunctions' => 'The Lambdafunction ARNs associated with the specified instance.
', ], ], 'GetAttachedFileRequest' => [ 'base' => 'Request to GetAttachedFile API.', 'refs' => [], ], 'GetAttachedFileResponse' => [ 'base' => 'Response from GetAttachedFile API.', 'refs' => [], ], 'GetContactAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContactAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCurrentMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCurrentMetricDataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCurrentUserDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCurrentUserDataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFederationTokenRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFederationTokenResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFlowAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFlowAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMetricDataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMetricDataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMetricDataV2Request' => [ 'base' => NULL, 'refs' => [], ], 'GetMetricDataV2Response' => [ 'base' => NULL, 'refs' => [], ], 'GetPromptFileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPromptFileResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTaskTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTaskTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTrafficDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTrafficDistributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Grouping' => [ 'base' => NULL, 'refs' => [ 'Groupings$member' => NULL, ], ], 'GroupingV2' => [ 'base' => NULL, 'refs' => [ 'GroupingsV2$member' => NULL, ], ], 'Groupings' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataRequest$Groupings' => 'The grouping applied to the metrics returned. For example, when grouped by QUEUE
, the metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by ROUTING_PROFILE
, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED
, CONTACTS_IN_QUEUE
, and OLDEST_CONTACT_AGE
.
If no Grouping
is included in the request, a summary of metrics is returned.
When using the RoutingStepExpression
filter, group by ROUTING_STEP_EXPRESSION
is required.
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
', ], ], 'GroupingsV2' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataV2Request$Groupings' => 'The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT
| AGENT_HIERARCHY_LEVEL_ONE
| AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
| CASE_TEMPLATE_ARN
| CASE_STATUS
| CHANNEL
| contact/segmentAttributes/connect:Subtype
| FLOWS_RESOURCE_ID
| FLOWS_MODULE_RESOURCE_ID
| FLOW_TYPE
| FLOWS_OUTCOME_TYPE
| INITIATION_METHOD
| Q_CONNECT_ENABLED
| QUEUE
| RESOURCE_PUBLISHED_TIMESTAMP
| ROUTING_PROFILE
| ROUTING_STEP_EXPRESSION
Contains information about a hierarchy group.
', 'refs' => [ 'DescribeUserHierarchyGroupResponse$HierarchyGroup' => 'Information about the hierarchy group.
', ], ], 'HierarchyGroupCondition' => [ 'base' => 'A leaf node condition which can be used to specify a hierarchy group condition.
', 'refs' => [ 'AttributeAndCondition$HierarchyGroupCondition' => NULL, 'ControlPlaneUserAttributeFilter$HierarchyGroupCondition' => NULL, 'UserSearchCriteria$HierarchyGroupCondition' => 'A leaf node condition which can be used to specify a hierarchy group condition.
', ], ], 'HierarchyGroupId' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$AllowedAccessControlHierarchyGroupId' => 'The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
', 'CreateUserHierarchyGroupRequest$ParentGroupId' => 'The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
', 'CreateUserHierarchyGroupResponse$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'CreateUserRequest$HierarchyGroupId' => 'The identifier of the hierarchy group for the user.
', 'DeleteUserHierarchyGroupRequest$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'DescribeUserHierarchyGroupRequest$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'HierarchyGroup$Id' => 'The identifier of the hierarchy group.
', 'HierarchyGroupIdList$member' => NULL, 'HierarchyGroupSummary$Id' => 'The identifier of the hierarchy group.
', 'HierarchyGroupSummaryReference$Id' => 'The unique identifier for the hierarchy group.
', 'SecurityProfile$AllowedAccessControlHierarchyGroupId' => 'The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
', 'UpdateSecurityProfileRequest$AllowedAccessControlHierarchyGroupId' => 'The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
', 'UpdateUserHierarchyGroupNameRequest$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'UpdateUserHierarchyRequest$HierarchyGroupId' => 'The identifier of the hierarchy group.
', 'User$HierarchyGroupId' => 'The identifier of the hierarchy group for the user.
', 'UserDataHierarchyGroups$member' => NULL, 'UserSearchSummary$HierarchyGroupId' => 'The identifier of the user\'s hierarchy group.
', ], ], 'HierarchyGroupIdList' => [ 'base' => NULL, 'refs' => [ 'AgentHierarchyGroups$L1Ids' => 'The identifiers for level 1 hierarchy groups.
', 'AgentHierarchyGroups$L2Ids' => 'The identifiers for level 2 hierarchy groups.
', 'AgentHierarchyGroups$L3Ids' => 'The identifiers for level 3 hierarchy groups.
', 'AgentHierarchyGroups$L4Ids' => 'The identifiers for level 4 hierarchy groups.
', 'AgentHierarchyGroups$L5Ids' => 'The identifiers for level 5 hierarchy groups.
', ], ], 'HierarchyGroupMatchType' => [ 'base' => NULL, 'refs' => [ 'HierarchyGroupCondition$HierarchyGroupMatchType' => 'The type of hierarchy group match.
', ], ], 'HierarchyGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateUserHierarchyGroupRequest$Name' => 'The name of the user hierarchy group. Must not be more than 100 characters.
', 'HierarchyGroup$Name' => 'The name of the hierarchy group.
', 'HierarchyGroupSummary$Name' => 'The name of the hierarchy group.
', 'UpdateUserHierarchyGroupNameRequest$Name' => 'The name of the hierarchy group. Must not be more than 100 characters.
', ], ], 'HierarchyGroupSummary' => [ 'base' => 'Contains summary information about a hierarchy group.
', 'refs' => [ 'HierarchyGroupSummaryList$member' => NULL, 'HierarchyPath$LevelOne' => 'Information about level one.
', 'HierarchyPath$LevelTwo' => 'Information about level two.
', 'HierarchyPath$LevelThree' => 'Information about level three.
', 'HierarchyPath$LevelFour' => 'Information about level four.
', 'HierarchyPath$LevelFive' => 'Information about level five.
', ], ], 'HierarchyGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListUserHierarchyGroupsResponse$UserHierarchyGroupSummaryList' => 'Information about the hierarchy groups.
', ], ], 'HierarchyGroupSummaryReference' => [ 'base' => 'Information about the hierarchy group.
', 'refs' => [ 'HierarchyPathReference$LevelOne' => 'Information about level one.
', 'HierarchyPathReference$LevelTwo' => 'Information about level two.
', 'HierarchyPathReference$LevelThree' => 'Information about level three.
', 'HierarchyPathReference$LevelFour' => 'Information about level four.
', 'HierarchyPathReference$LevelFive' => 'Information about level five.
', ], ], 'HierarchyGroups' => [ 'base' => 'Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
', 'refs' => [ 'AgentInfo$HierarchyGroups' => 'The agent hierarchy groups for the agent.
', ], ], 'HierarchyLevel' => [ 'base' => 'Contains information about a hierarchy level.
', 'refs' => [ 'HierarchyStructure$LevelOne' => 'Information about level one.
', 'HierarchyStructure$LevelTwo' => 'Information about level two.
', 'HierarchyStructure$LevelThree' => 'Information about level three.
', 'HierarchyStructure$LevelFour' => 'Information about level four.
', 'HierarchyStructure$LevelFive' => 'Information about level five.
', ], ], 'HierarchyLevelId' => [ 'base' => NULL, 'refs' => [ 'HierarchyGroup$LevelId' => 'The identifier of the level in the hierarchy group.
', 'HierarchyLevel$Id' => 'The identifier of the hierarchy level.
', ], ], 'HierarchyLevelName' => [ 'base' => NULL, 'refs' => [ 'HierarchyLevel$Name' => 'The name of the hierarchy level.
', 'HierarchyLevelUpdate$Name' => 'The name of the user hierarchy level. Must not be more than 50 characters.
', ], ], 'HierarchyLevelUpdate' => [ 'base' => 'Contains information about the hierarchy level to update.
', 'refs' => [ 'HierarchyStructureUpdate$LevelOne' => 'The update for level one.
', 'HierarchyStructureUpdate$LevelTwo' => 'The update for level two.
', 'HierarchyStructureUpdate$LevelThree' => 'The update for level three.
', 'HierarchyStructureUpdate$LevelFour' => 'The update for level four.
', 'HierarchyStructureUpdate$LevelFive' => 'The update for level five.
', ], ], 'HierarchyPath' => [ 'base' => 'Contains information about the levels of a hierarchy group.
', 'refs' => [ 'HierarchyGroup$HierarchyPath' => 'Information about the levels in the hierarchy group.
', ], ], 'HierarchyPathReference' => [ 'base' => 'Information about the levels in the hierarchy group.
', 'refs' => [ 'UserData$HierarchyPath' => 'Contains information about the levels of a hierarchy group assigned to a user.
', ], ], 'HierarchyRestrictedResourceList' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$HierarchyRestrictedResources' => 'The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
.
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
.
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
.
Contains information about a hierarchy structure.
', 'refs' => [ 'DescribeUserHierarchyStructureResponse$HierarchyStructure' => 'Information about the hierarchy structure.
', ], ], 'HierarchyStructureUpdate' => [ 'base' => 'Contains information about the level hierarchy to update.
', 'refs' => [ 'UpdateUserHierarchyStructureRequest$HierarchyStructure' => 'The hierarchy levels to update.
', ], ], 'HistoricalMetric' => [ 'base' => 'Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
', 'refs' => [ 'HistoricalMetricData$Metric' => 'Information about the metric.
', 'HistoricalMetrics$member' => NULL, ], ], 'HistoricalMetricData' => [ 'base' => 'Contains the data for a historical metric.
', 'refs' => [ 'HistoricalMetricDataCollections$member' => NULL, ], ], 'HistoricalMetricDataCollections' => [ 'base' => NULL, 'refs' => [ 'HistoricalMetricResult$Collections' => 'The set of metrics.
', ], ], 'HistoricalMetricName' => [ 'base' => 'The historical metric names.
', 'refs' => [ 'HistoricalMetric$Name' => 'The name of the metric.
', ], ], 'HistoricalMetricResult' => [ 'base' => 'Contains information about the historical metrics retrieved.
', 'refs' => [ 'HistoricalMetricResults$member' => NULL, ], ], 'HistoricalMetricResults' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataResponse$MetricResults' => 'Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
', ], ], 'HistoricalMetrics' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataRequest$HistoricalMetrics' => 'The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there\'s no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
', ], ], 'Hours24Format' => [ 'base' => NULL, 'refs' => [ 'HoursOfOperationTimeSlice$Hours' => 'The hours.
', ], ], 'HoursOfOperation' => [ 'base' => 'Information about of the hours of operation.
', 'refs' => [ 'DescribeHoursOfOperationResponse$HoursOfOperation' => 'The hours of operation.
', 'HoursOfOperationList$member' => NULL, ], ], 'HoursOfOperationConfig' => [ 'base' => 'Contains information about the hours of operation.
', 'refs' => [ 'HoursOfOperationConfigList$member' => NULL, ], ], 'HoursOfOperationConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationRequest$Config' => 'Configuration information for the hours of operation: day, start time, and end time.
', 'HoursOfOperation$Config' => 'Configuration information for the hours of operation.
', 'UpdateHoursOfOperationRequest$Config' => 'Configuration information of the hours of operation.
', ], ], 'HoursOfOperationDays' => [ 'base' => NULL, 'refs' => [ 'HoursOfOperationConfig$Day' => 'The day that the hours of operation applies to.
', ], ], 'HoursOfOperationDescription' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationRequest$Description' => 'The description of the hours of operation.
', 'HoursOfOperation$Description' => 'The description for the hours of operation.
', ], ], 'HoursOfOperationId' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationResponse$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'CreateQueueRequest$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'DeleteHoursOfOperationRequest$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'DescribeHoursOfOperationRequest$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'HoursOfOperation$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'HoursOfOperationSummary$Id' => 'The identifier of the hours of operation.
', 'Queue$HoursOfOperationId' => 'The identifier for the hours of operation.
', 'UpdateHoursOfOperationRequest$HoursOfOperationId' => 'The identifier of the hours of operation.
', 'UpdateQueueHoursOfOperationRequest$HoursOfOperationId' => 'The identifier for the hours of operation.
', ], ], 'HoursOfOperationList' => [ 'base' => NULL, 'refs' => [ 'SearchHoursOfOperationsResponse$HoursOfOperations' => 'Information about the hours of operations.
', ], ], 'HoursOfOperationName' => [ 'base' => NULL, 'refs' => [ 'HoursOfOperationSummary$Name' => 'The name of the hours of operation.
', ], ], 'HoursOfOperationSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'HoursOfOperationSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'HoursOfOperationSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'HoursOfOperationSearchCriteria' => [ 'base' => 'The search criteria to be used to return hours of operations.
', 'refs' => [ 'HoursOfOperationSearchConditionList$member' => NULL, 'SearchHoursOfOperationsRequest$SearchCriteria' => 'The search criteria to be used to return hours of operations.
', ], ], 'HoursOfOperationSearchFilter' => [ 'base' => 'Filters to be applied to search results.
', 'refs' => [ 'SearchHoursOfOperationsRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'HoursOfOperationSummary' => [ 'base' => 'Contains summary information about hours of operation for a contact center.
', 'refs' => [ 'HoursOfOperationSummaryList$member' => NULL, ], ], 'HoursOfOperationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListHoursOfOperationsResponse$HoursOfOperationSummaryList' => 'Information about the hours of operation.
', ], ], 'HoursOfOperationTimeSlice' => [ 'base' => 'The start time or end time for an hours of operation.
', 'refs' => [ 'HoursOfOperationConfig$StartTime' => 'The start time that your contact center opens.
', 'HoursOfOperationConfig$EndTime' => 'The end time that your contact center closes.
', ], ], 'ISO8601Datetime' => [ 'base' => NULL, 'refs' => [ 'AttachedFile$CreationTime' => 'The time of Creation of the file resource as an ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example, 2024-05-03T02:41:28.172Z
.
The expiration time of the URL in ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
', 'GetAttachedFileResponse$CreationTime' => 'The time of Creation of the file resource as an ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example, 2024-05-03T02:41:28.172Z
.
The expiration of the token. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
', 'StartAttachedFileUploadResponse$CreationTime' => 'The time of Creation of the file resource as an ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example, 2024-05-03T02:41:28.172Z
.
The expiration time of the URL in ISO timestamp. It\'s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ
. For example, 2019-11-08T02:41:28.172Z
.
An entity with the same name already exists.
', 'refs' => [], ], 'ImportPhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportPhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'InboundCallsEnabled' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceRequest$InboundCallsEnabled' => 'Your contact center handles incoming contacts.
', 'Instance$InboundCallsEnabled' => 'Whether inbound calls are enabled.
', 'InstanceSummary$InboundCallsEnabled' => 'Whether inbound calls are enabled.
', ], ], 'Index' => [ 'base' => NULL, 'refs' => [ 'RoutingCriteria$Index' => 'Information about the index of the routing criteria.
', ], ], 'InitiationMethodList' => [ 'base' => NULL, 'refs' => [ 'SearchCriteria$InitiationMethods' => 'The list of initiation methods associated with contacts.
', ], ], 'Instance' => [ 'base' => 'The Amazon Connect instance.
', 'refs' => [ 'DescribeInstanceResponse$Instance' => 'The name of the instance.
', ], ], 'InstanceArn' => [ 'base' => NULL, 'refs' => [ 'TrafficDistributionGroup$InstanceArn' => 'The Amazon Resource Name (ARN).
', 'TrafficDistributionGroupSummary$InstanceArn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', ], ], 'InstanceAttributeType' => [ 'base' => NULL, 'refs' => [ 'Attribute$AttributeType' => 'The type of attribute.
', 'DescribeInstanceAttributeRequest$AttributeType' => 'The type of attribute.
', 'UpdateInstanceAttributeRequest$AttributeType' => 'The type of attribute.
Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
The value of the attribute.
', 'UpdateInstanceAttributeRequest$Value' => 'The value for the attribute. Maximum character limit is 100.
', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'ActivateEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateAnalyticsDataSetRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateApprovedOriginRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateBotRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateDefaultVocabularyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateInstanceStorageConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateLambdaFunctionRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateLexBotRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociatePhoneNumberContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateQueueQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateRoutingProfileQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateSecurityKeyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateTrafficDistributionGroupUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'AssociateUserProficienciesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).
', 'BatchAssociateAnalyticsDataSetRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'BatchDisassociateAnalyticsDataSetRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'BatchGetAttachedFileMetadataRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'BatchGetFlowAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'BatchPutContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ClaimPhoneNumberRequest$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CompleteAttachedFileUploadRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'CreateAgentStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateContactFlowModuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'CreateEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateInstanceResponse$Id' => 'The identifier for the instance.
', 'CreateIntegrationAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateParticipantRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreatePersistentContactAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreatePredefinedAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreatePromptRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateQueueRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateQuickConnectRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateRoutingProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateRuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateSecurityProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateTaskTemplateRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateUseCaseRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateUserHierarchyGroupRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'CreateVocabularyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeactivateEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DefaultVocabulary$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteAttachedFileRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'DeleteContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteContactFlowModuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteInstanceRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteIntegrationAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeletePredefinedAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeletePromptRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteQueueRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteQuickConnectRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteRoutingProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteRuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteSecurityProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteTaskTemplateRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteUseCaseRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteUserHierarchyGroupRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DeleteVocabularyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeAgentStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeContactFlowModuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'DescribeContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeInstanceAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeInstanceRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeInstanceStorageConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribePredefinedAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribePromptRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeQueueRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeQuickConnectRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeRoutingProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeRuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeSecurityProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeUserHierarchyGroupRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeUserHierarchyStructureRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DescribeVocabularyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateAnalyticsDataSetRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateApprovedOriginRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateBotRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateInstanceStorageConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateLambdaFunctionRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..
', 'DisassociateLexBotRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociatePhoneNumberContactFlowRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateQueueQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateRoutingProfileQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateSecurityKeyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateTrafficDistributionGroupUserRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DisassociateUserProficienciesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'DismissUserContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'GetAttachedFileRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'GetContactAttributesRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'GetCurrentMetricDataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetCurrentUserDataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetFederationTokenRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetFlowAssociationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetMetricDataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetPromptFileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetTaskTemplateRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'GetTaskTemplateResponse$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ImportPhoneNumberRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'Instance$Id' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'InstanceSummary$Id' => 'The identifier of the instance.
', 'IntegrationAssociationSummary$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListAgentStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListAnalyticsDataAssociationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListApprovedOriginsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListBotsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListContactEvaluationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListContactFlowModulesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListContactFlowsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListContactReferencesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListDefaultVocabulariesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListEvaluationFormVersionsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListEvaluationFormsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListFlowAssociationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListHoursOfOperationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListInstanceAttributesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListInstanceStorageConfigsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListIntegrationAssociationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListLambdaFunctionsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListLexBotsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListPhoneNumbersRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListPhoneNumbersSummary$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListPhoneNumbersV2Request$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. If both TargetArn
and InstanceId
are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListPromptsRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'ListQueueQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListRealtimeContactAnalysisSegmentsV2Request$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListRoutingProfileQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListRoutingProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListRulesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListSecurityKeysRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListSecurityProfileApplicationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListSecurityProfilePermissionsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListSecurityProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListTaskTemplatesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListUseCasesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListUserHierarchyGroupsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListUserProficienciesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ListUsersRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'MonitorContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'PauseContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ReplicateInstanceResponse$Id' => 'The identifier of the replicated instance. You can find the instanceId
in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ResumeContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchAvailablePhoneNumbersRequest$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchContactFlowsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchContactsRequest$InstanceId' => 'The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchHoursOfOperationsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchPredefinedAttributesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchPromptsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchQuickConnectsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchRoutingProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchSecurityProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SearchUsersRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
InstanceID is a required field. The "Required: No" below is incorrect.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SecurityProfile$OrganizationResourceId' => 'The organization resource identifier for the security profile.
', 'SecurityProfileSearchSummary$OrganizationResourceId' => 'The organization resource identifier.
', 'StartAttachedFileUploadRequest$InstanceId' => 'The unique identifier of the Connect instance.
', 'StartChatContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartContactRecordingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartContactStreamingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartOutboundVoiceContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartTaskContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StartWebRTCContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StopContactRecordingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StopContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'StopContactStreamingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SubmitContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'SuspendContactRecordingRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'TagContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'TransferContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UntagContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateAgentStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactAttributesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactEvaluationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactFlowContentRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'UpdateContactFlowMetadataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactFlowModuleContentRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactFlowModuleMetadataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactFlowNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance.
', 'UpdateContactRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactRoutingDataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateContactScheduleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateEvaluationFormRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateInstanceAttributeRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateInstanceStorageConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateParticipantRoleConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdatePhoneNumberRequest$InstanceId' => 'The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdatePromptRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueHoursOfOperationRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueMaxContactsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueOutboundCallerConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQueueStatusRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQuickConnectConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateQuickConnectNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileAgentAvailabilityTimerRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileConcurrencyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileDefaultOutboundQueueRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRoutingProfileQueuesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateRuleRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateSecurityProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateTaskTemplateRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateTaskTemplateResponse$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserHierarchyGroupNameRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserHierarchyRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserHierarchyStructureRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserIdentityInfoRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserPhoneConfigRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserProficienciesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserRoutingProfileRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'UpdateUserSecurityProfilesRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', ], ], 'InstanceIdOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupRequest$InstanceId' => 'The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId
in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
', 'ReplicateInstanceRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId
, or the entire ARN.
The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.
', ], ], 'InstanceStatus' => [ 'base' => NULL, 'refs' => [ 'Instance$InstanceStatus' => 'The state of the instance.
', 'InstanceSummary$InstanceStatus' => 'The state of the instance.
', ], ], 'InstanceStatusReason' => [ 'base' => 'Relevant details why the instance was not successfully created.
', 'refs' => [ 'Instance$StatusReason' => 'Relevant details why the instance was not successfully created.
', ], ], 'InstanceStorageConfig' => [ 'base' => 'The storage configuration for the instance.
', 'refs' => [ 'AssociateInstanceStorageConfigRequest$StorageConfig' => 'A valid storage type.
', 'DescribeInstanceStorageConfigResponse$StorageConfig' => 'A valid storage type.
', 'InstanceStorageConfigs$member' => NULL, 'UpdateInstanceStorageConfigRequest$StorageConfig' => NULL, ], ], 'InstanceStorageConfigs' => [ 'base' => NULL, 'refs' => [ 'ListInstanceStorageConfigsResponse$StorageConfigs' => 'A valid storage type.
', ], ], 'InstanceStorageResourceType' => [ 'base' => NULL, 'refs' => [ 'AssociateInstanceStorageConfigRequest$ResourceType' => 'A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:
For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
.
For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
.
REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
for voice contacts moving forward.
If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
.
A valid resource type.
', 'DisassociateInstanceStorageConfigRequest$ResourceType' => 'A valid resource type.
', 'ListInstanceStorageConfigsRequest$ResourceType' => 'A valid resource type.
', 'UpdateInstanceStorageConfigRequest$ResourceType' => 'A valid resource type.
', ], ], 'InstanceSummary' => [ 'base' => 'Information about the instance.
', 'refs' => [ 'InstanceSummaryList$member' => NULL, ], ], 'InstanceSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesResponse$InstanceSummaryList' => 'Information about the instances.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormNumericQuestionOption$MinValue' => 'The minimum answer value of the range option.
', 'EvaluationFormNumericQuestionOption$MaxValue' => 'The maximum answer value of the range option.
', 'EvaluationFormNumericQuestionProperties$MinValue' => 'The minimum answer value.
', 'EvaluationFormNumericQuestionProperties$MaxValue' => 'The maximum answer value.
', ], ], 'IntegerCount' => [ 'base' => NULL, 'refs' => [ 'ChannelToCountMap$value' => NULL, ], ], 'IntegrationAssociationId' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationResponse$IntegrationAssociationId' => 'The identifier for the integration association.
', 'CreateUseCaseRequest$IntegrationAssociationId' => 'The identifier for the integration association.
', 'DeleteIntegrationAssociationRequest$IntegrationAssociationId' => 'The identifier for the integration association.
', 'DeleteUseCaseRequest$IntegrationAssociationId' => 'The identifier for the integration association.
', 'IntegrationAssociationSummary$IntegrationAssociationId' => 'The identifier for the AppIntegration association.
', 'ListUseCasesRequest$IntegrationAssociationId' => 'The identifier for the integration association.
', 'RuleTriggerEventSource$IntegrationAssociationId' => 'The identifier for the integration association.
', ], ], 'IntegrationAssociationSummary' => [ 'base' => 'Contains summary information about the associated AppIntegrations.
', 'refs' => [ 'IntegrationAssociationSummaryList$member' => NULL, ], ], 'IntegrationAssociationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListIntegrationAssociationsResponse$IntegrationAssociationSummaryList' => 'The associations.
', ], ], 'IntegrationType' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationRequest$IntegrationType' => 'The type of information to be ingested.
', 'IntegrationAssociationSummary$IntegrationType' => 'The integration type.
', 'ListIntegrationAssociationsRequest$IntegrationType' => 'The integration type.
', ], ], 'InternalServiceException' => [ 'base' => 'Request processing failed because of an error or failure with the service.
', 'refs' => [], ], 'IntervalDetails' => [ 'base' => 'Information about the interval period to use for returning results.
', 'refs' => [ 'GetMetricDataV2Request$Interval' => 'The interval period and timezone to apply to returned metrics.
IntervalPeriod
: An aggregated grouping applied to request metrics. Valid IntervalPeriod
values are: FIFTEEN_MIN
| THIRTY_MIN
| HOUR
| DAY
| WEEK
| TOTAL
.
For example, if IntervalPeriod
is selected THIRTY_MIN
, StartTime
and EndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL
interval period.
The following list describes restrictions on StartTime
and EndTime
based on which IntervalPeriod
is requested.
FIFTEEN_MIN
: The difference between StartTime
and EndTime
must be less than 3 days.
THIRTY_MIN
: The difference between StartTime
and EndTime
must be less than 3 days.
HOUR
: The difference between StartTime
and EndTime
must be less than 3 days.
DAY
: The difference between StartTime
and EndTime
must be less than 35 days.
WEEK
: The difference between StartTime
and EndTime
must be less than 35 days.
TOTAL
: The difference between StartTime
and EndTime
must be less than 35 days.
TimeZone
: The timezone applied to requested metrics.
IntervalPeriod
: An aggregated grouping applied to request metrics. Valid IntervalPeriod
values are: FIFTEEN_MIN
| THIRTY_MIN
| HOUR
| DAY
| WEEK
| TOTAL
.
For example, if IntervalPeriod
is selected THIRTY_MIN
, StartTime
and EndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL
interval period.
The following list describes restrictions on StartTime
and EndTime
based on what IntervalPeriod
is requested.
FIFTEEN_MIN
: The difference between StartTime
and EndTime
must be less than 3 days.
THIRTY_MIN
: The difference between StartTime
and EndTime
must be less than 3 days.
HOUR
: The difference between StartTime
and EndTime
must be less than 3 days.
DAY
: The difference between StartTime
and EndTime
must be less than 35 days.
WEEK
: The difference between StartTime
and EndTime
must be less than 35 days.
TOTAL
: The difference between StartTime
and EndTime
must be less than 35 days.
The interval period provided in the API request.
', ], ], 'InvalidContactFlowException' => [ 'base' => 'The flow is not valid.
', 'refs' => [], ], 'InvalidContactFlowModuleException' => [ 'base' => 'The problems with the module. Please fix before trying again.
', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => 'One or more of the specified parameters are not valid.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'The request is not valid.
', 'refs' => [], ], 'InvalidRequestExceptionReason' => [ 'base' => 'Reason why the request was invalid.
', 'refs' => [ 'InvalidRequestException$Reason' => NULL, ], ], 'InvisibleFieldInfo' => [ 'base' => 'A field that is invisible to an agent.
', 'refs' => [ 'InvisibleTaskTemplateFields$member' => NULL, ], ], 'InvisibleTaskTemplateFields' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateConstraints$InvisibleFields' => 'Lists the fields that are invisible to agents.
', ], ], 'JoinToken' => [ 'base' => NULL, 'refs' => [ 'Attendee$JoinToken' => 'The join token used by the Amazon Chime SDK attendee.
', ], ], 'KeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfig$KeyId' => 'The full ARN of the encryption key.
Be sure to provide the full ARN of the encryption key, not just the ID.
Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT
.
Configuration information of a Kinesis Data Firehose delivery stream.
', 'refs' => [ 'InstanceStorageConfig$KinesisFirehoseConfig' => 'The configuration of the Kinesis Firehose delivery stream.
', ], ], 'KinesisStreamConfig' => [ 'base' => 'Configuration information of a Kinesis data stream.
', 'refs' => [ 'InstanceStorageConfig$KinesisStreamConfig' => 'The configuration of the Kinesis data stream.
', ], ], 'KinesisVideoStreamConfig' => [ 'base' => 'Configuration information of a Kinesis video stream.
', 'refs' => [ 'InstanceStorageConfig$KinesisVideoStreamConfig' => 'The configuration of the Kinesis video stream.
', ], ], 'LargeNextToken' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersV2Request$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.
', 'ListPhoneNumbersV2Response$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRealtimeContactAnalysisSegmentsV2Request$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.
', 'ListRealtimeContactAnalysisSegmentsV2Response$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchAvailablePhoneNumbersRequest$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.
', 'SearchAvailablePhoneNumbersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchContactsRequest$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.
', 'SearchContactsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'LexBot' => [ 'base' => 'Configuration information of an Amazon Lex bot.
', 'refs' => [ 'AssociateBotRequest$LexBot' => NULL, 'AssociateLexBotRequest$LexBot' => 'The Amazon Lex bot to associate with the instance.
', 'DisassociateBotRequest$LexBot' => NULL, 'LexBotConfig$LexBot' => NULL, 'LexBotsList$member' => NULL, ], ], 'LexBotConfig' => [ 'base' => 'Configuration information of an Amazon Lex or Amazon Lex V2 bot.
', 'refs' => [ 'LexBotConfigList$member' => NULL, ], ], 'LexBotConfigList' => [ 'base' => NULL, 'refs' => [ 'ListBotsResponse$LexBots' => 'The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.
', ], ], 'LexBotsList' => [ 'base' => NULL, 'refs' => [ 'ListLexBotsResponse$LexBots' => 'The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.
', ], ], 'LexRegion' => [ 'base' => NULL, 'refs' => [ 'DisassociateLexBotRequest$LexRegion' => 'The Amazon Web Services Region in which the Amazon Lex bot has been created.
', 'LexBot$LexRegion' => 'The Amazon Web Services Region where the Amazon Lex bot was created.
', ], ], 'LexV2Bot' => [ 'base' => 'Configuration information of an Amazon Lex V2 bot.
', 'refs' => [ 'AssociateBotRequest$LexV2Bot' => 'The Amazon Lex V2 bot to associate with the instance.
', 'DisassociateBotRequest$LexV2Bot' => 'The Amazon Lex V2 bot to disassociate from the instance.
', 'LexBotConfig$LexV2Bot' => 'Configuration information of an Amazon Lex V2 bot.
', ], ], 'LexVersion' => [ 'base' => NULL, 'refs' => [ 'ListBotsRequest$LexVersion' => 'The version of Amazon Lex or Amazon Lex V2.
', ], ], 'LimitExceededException' => [ 'base' => 'The allowed limit for the resource has been exceeded.
', 'refs' => [], ], 'ListAgentStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAgentStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAnalyticsDataAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAnalyticsDataAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListApprovedOriginsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApprovedOriginsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListBotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBotsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactEvaluationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactEvaluationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactFlowModulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactFlowModulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactFlowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactFlowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactReferencesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactReferencesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDefaultVocabulariesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDefaultVocabulariesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEvaluationFormVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEvaluationFormVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEvaluationFormsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEvaluationFormsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowAssociationResourceType' => [ 'base' => NULL, 'refs' => [ 'BatchGetFlowAssociationRequest$ResourceType' => 'The type of resource association.
', 'FlowAssociationSummary$ResourceType' => 'The type of resource association.
', 'ListFlowAssociationsRequest$ResourceType' => 'A valid resource type.
', ], ], 'ListFlowAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListHoursOfOperationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListHoursOfOperationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceStorageConfigsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceStorageConfigsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIntegrationAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIntegrationAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLambdaFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLambdaFunctionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListLexBotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLexBotsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersSummary' => [ 'base' => 'Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
', 'refs' => [ 'ListPhoneNumbersSummaryList$member' => NULL, ], ], 'ListPhoneNumbersSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersV2Response$ListPhoneNumbersSummaryList' => 'Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.
', ], ], 'ListPhoneNumbersV2Request' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersV2Response' => [ 'base' => NULL, 'refs' => [], ], 'ListPredefinedAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPredefinedAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPromptsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPromptsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListQueueQuickConnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListQueueQuickConnectsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListQueuesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListQuickConnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListQuickConnectsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRealtimeContactAnalysisSegmentsV2Request' => [ 'base' => NULL, 'refs' => [], ], 'ListRealtimeContactAnalysisSegmentsV2Response' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingProfileQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingProfileQueuesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRoutingProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfileApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfileApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfilePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfilePermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskTemplatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskTemplatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrafficDistributionGroupUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrafficDistributionGroupUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTrafficDistributionGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTrafficDistributionGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUseCasesRequest' => [ 'base' => 'Provides summary information about the use cases for the specified integration association.
', 'refs' => [], ], 'ListUseCasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserHierarchyGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserHierarchyGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProficienciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUserProficienciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListViewVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListViewVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListViewsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListViewsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'RoutingProfile$NumberOfAssociatedQueues' => 'The number of associated queues in routing profile.
', 'RoutingProfile$NumberOfAssociatedUsers' => 'The number of associated users in routing profile.
', ], ], 'MatchCriteria' => [ 'base' => 'An object to define AgentsCriteria
.
An object to define AgentsCriteria
.
The maximum number of results to return per page.
', 'ListInstancesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListTrafficDistributionGroupUsersRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListTrafficDistributionGroupsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchAvailablePhoneNumbersRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult100' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataRequest$MaxResults' => 'The maximum number of results to return per page.
', 'GetCurrentUserDataRequest$MaxResults' => 'The maximum number of results to return per page.
', 'GetMetricDataRequest$MaxResults' => 'The maximum number of results to return per page.
', 'GetMetricDataV2Request$MaxResults' => 'The maximum number of results to return per page.
', 'ListDefaultVocabulariesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListEvaluationFormVersionsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListEvaluationFormsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListIntegrationAssociationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListPredefinedAttributesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListQueueQuickConnectsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListRealtimeContactAnalysisSegmentsV2Request$MaxResults' => 'The maximum number of results to return per page.
', 'ListRoutingProfileQueuesRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListTaskTemplatesRequest$MaxResults' => 'The maximum number of results to return per page.
It is not expected that you set this.
The maximum number of results to return per page.
', 'ListUserProficienciesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchContactFlowModulesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchContactFlowsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchContactsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchHoursOfOperationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchPredefinedAttributesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchPromptsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchQuickConnectsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchResourceTagsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchSecurityProfilesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchVocabulariesRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult1000' => [ 'base' => NULL, 'refs' => [ 'ListAgentStatusRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListAnalyticsDataAssociationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListContactFlowModulesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListContactFlowsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListFlowAssociationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListHoursOfOperationsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListPhoneNumbersRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListPhoneNumbersV2Request$MaxResults' => 'The maximum number of results to return per page.
', 'ListPromptsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListQueuesRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListQuickConnectsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListRoutingProfilesRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListSecurityProfileApplicationsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListSecurityProfilePermissionsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListSecurityProfilesRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListUserHierarchyGroupsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListUsersRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', ], ], 'MaxResult2' => [ 'base' => NULL, 'refs' => [ 'ListSecurityKeysRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult200' => [ 'base' => NULL, 'refs' => [ 'ListRulesRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult25' => [ 'base' => NULL, 'refs' => [ 'ListApprovedOriginsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListBotsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListLambdaFunctionsRequest$MaxResults' => 'The maximum number of results to return per page.
', 'ListLexBotsRequest$MaxResults' => 'The maximum number of results to return per page. If no value is specified, the default is 10.
', ], ], 'MaxResult500' => [ 'base' => NULL, 'refs' => [ 'SearchQueuesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchRoutingProfilesRequest$MaxResults' => 'The maximum number of results to return per page.
', 'SearchUsersRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResult7' => [ 'base' => NULL, 'refs' => [ 'ListInstanceAttributesRequest$MaxResults' => 'The maximum number of results to return per page.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListViewVersionsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', 'ListViewsRequest$MaxResults' => 'The maximum number of results to return per page. The default MaxResult size is 100.
', ], ], 'MaximumResultReturnedException' => [ 'base' => 'Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
', 'refs' => [], ], 'MediaConcurrencies' => [ 'base' => NULL, 'refs' => [ 'CreateRoutingProfileRequest$MediaConcurrencies' => 'The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
', 'RoutingProfile$MediaConcurrencies' => 'The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
', 'UpdateRoutingProfileConcurrencyRequest$MediaConcurrencies' => 'The channels that agents can handle in the Contact Control Panel (CCP).
', ], ], 'MediaConcurrency' => [ 'base' => 'Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
', 'refs' => [ 'MediaConcurrencies$member' => NULL, ], ], 'MediaPlacement' => [ 'base' => 'A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
', 'refs' => [ 'Meeting$MediaPlacement' => 'The media placement for the meeting.
', ], ], 'MediaRegion' => [ 'base' => NULL, 'refs' => [ 'Meeting$MediaRegion' => 'The Amazon Web Services Region in which you create the meeting.
', ], ], 'Meeting' => [ 'base' => 'A meeting created using the Amazon Chime SDK.
', 'refs' => [ 'ConnectionData$Meeting' => 'A meeting created using the Amazon Chime SDK.
', ], ], 'MeetingFeatureStatus' => [ 'base' => NULL, 'refs' => [ 'AudioFeatures$EchoReduction' => 'Makes echo reduction available to clients who connect to the meeting.
', ], ], 'MeetingFeaturesConfiguration' => [ 'base' => 'The configuration settings of the features available to a meeting.
', 'refs' => [ 'Meeting$MeetingFeatures' => 'The configuration settings of the features available to a meeting.
', ], ], 'MeetingId' => [ 'base' => NULL, 'refs' => [ 'Meeting$MeetingId' => 'The Amazon Chime SDK meeting ID.
', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConflictException$Message' => NULL, 'ContactFlowNotPublishedException$Message' => NULL, 'ContactNotFoundException$Message' => 'The message.
', 'DestinationNotAllowedException$Message' => 'The message about the outbound calls.
', 'DuplicateResourceException$Message' => NULL, 'IdempotencyException$Message' => NULL, 'InternalServiceException$Message' => 'The message.
', 'InvalidParameterException$Message' => 'The message about the parameters.
', 'InvalidRequestException$Message' => 'The message about the request.
', 'LimitExceededException$Message' => 'The message about the limit.
', 'MaximumResultReturnedException$Message' => NULL, 'OutboundContactNotPermittedException$Message' => 'The message about the contact.
', 'OutputTypeNotFoundException$Message' => NULL, 'PropertyValidationException$Message' => NULL, 'PropertyValidationExceptionProperty$Message' => 'A message describing why the property is not valid.
', 'ResourceConflictException$Message' => NULL, 'ResourceInUseException$Message' => NULL, 'ResourceNotFoundException$Message' => 'The message about the resource.
', 'ResourceNotReadyException$Message' => NULL, 'ServiceQuotaExceededException$Message' => NULL, 'ThrottlingException$Message' => NULL, 'TooManyRequestsException$Message' => NULL, 'UserNotFoundException$Message' => NULL, ], ], 'MetadataUrl' => [ 'base' => NULL, 'refs' => [ 'DownloadUrlMetadata$Url' => 'A pre-signed URL that should be used to download the attached file.
', 'UploadUrlMetadata$Url' => 'A pre-signed S3 URL that should be used for uploading the attached file.
', ], ], 'MetricDataCollectionsV2' => [ 'base' => NULL, 'refs' => [ 'MetricResultV2$Collections' => 'The set of metrics.
', ], ], 'MetricDataV2' => [ 'base' => 'Contains the name, thresholds, and metric filters.
', 'refs' => [ 'MetricDataCollectionsV2$member' => NULL, ], ], 'MetricFilterV2' => [ 'base' => 'Contains information about the filter used when retrieving metrics. MetricFiltersV2
can be used on the following metrics: AVG_AGENT_CONNECTING_TIME
, CONTACTS_CREATED
, CONTACTS_HANDLED
, SUM_CONTACTS_DISCONNECTED
.
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
| OUTBOUND
| TRANSFER
| QUEUE_TRANSFER
| CALLBACK
| API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
| AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
| BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
| API
Contains the filters to be used when returning data.
', ], ], 'MetricInterval' => [ 'base' => 'The interval period with the start and end time for the metrics.
', 'refs' => [ 'MetricResultV2$MetricInterval' => 'The interval period with the start and end time for the metrics.
', ], ], 'MetricNameV2' => [ 'base' => NULL, 'refs' => [ 'MetricV2$Name' => 'The name of the metric.
This parameter is required. The following Required = No is incorrect.
Contains information about the metric results.
', 'refs' => [ 'MetricResultsV2$member' => NULL, ], ], 'MetricResultsV2' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataV2Response$MetricResults' => 'Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.
', ], ], 'MetricV2' => [ 'base' => 'Contains information about the metric.
', 'refs' => [ 'MetricDataV2$Metric' => 'The metric name, thresholds, and metric filters of the returned metric.
', 'MetricsV2$member' => NULL, ], ], 'MetricsV2' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataV2Request$Metrics' => 'The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. For now, this metric only supports the following as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: This metric is not available in Amazon Connect admin website.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE
is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API
| Incoming
| Outbound
| Transfer
| Callback
| Queue_Transfer
| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The minutes.
', ], ], 'MonitorCapability' => [ 'base' => NULL, 'refs' => [ 'AllowedMonitorCapabilities$member' => NULL, ], ], 'MonitorContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'MonitorContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'Contact$Name' => 'The name of the contact.
', 'StartOutboundVoiceContactRequest$Name' => 'The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
', 'StartTaskContactRequest$Name' => 'The name of a task that is shown to an agent in the Contact Control Panel (CCP).
', 'UpdateContactRequest$Name' => 'The name of the contact.
', ], ], 'Name128' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupRequest$Name' => 'The name for the traffic distribution group.
', 'TrafficDistributionGroup$Name' => 'The name of the traffic distribution group.
', 'TrafficDistributionGroupSummary$Name' => 'The name of the traffic distribution group.
', ], ], 'Namespace' => [ 'base' => NULL, 'refs' => [ 'Application$Namespace' => 'Namespace of the application that you want to give access to.
', ], ], 'NewChatCreated' => [ 'base' => NULL, 'refs' => [ 'SendChatIntegrationEventResponse$NewChatCreated' => 'Whether handling the integration event resulted in creating a new chat or acting on existing chat.
', ], ], 'NewSessionDetails' => [ 'base' => 'Payload of chat properties to apply when starting a new contact.
', 'refs' => [ 'SendChatIntegrationEventRequest$NewSessionDetails' => 'Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'GetCurrentMetricDataRequest$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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
', 'GetCurrentMetricDataResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
', 'GetCurrentUserDataRequest$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.
', 'GetCurrentUserDataResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'GetMetricDataRequest$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.
', 'GetMetricDataResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
', 'ListAgentStatusRequest$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.
', 'ListAgentStatusResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListAnalyticsDataAssociationsRequest$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.
', 'ListAnalyticsDataAssociationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListApprovedOriginsRequest$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.
', 'ListApprovedOriginsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListBotsRequest$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.
', 'ListBotsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListContactEvaluationsRequest$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.
This is not expected to be set because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as null in the response.
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.
', 'ListContactFlowModulesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListContactFlowsRequest$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.
', 'ListContactFlowsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListContactReferencesRequest$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.
This is not expected to be set, because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as null in the response.
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.
', 'ListEvaluationFormVersionsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListEvaluationFormsRequest$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.
', 'ListEvaluationFormsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListFlowAssociationsRequest$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.
', 'ListFlowAssociationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListHoursOfOperationsRequest$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.
', 'ListHoursOfOperationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListInstanceAttributesRequest$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.
', 'ListInstanceAttributesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListInstanceStorageConfigsRequest$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.
', 'ListInstanceStorageConfigsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListInstancesRequest$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.
', 'ListInstancesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListIntegrationAssociationsRequest$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.
', 'ListIntegrationAssociationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListLambdaFunctionsRequest$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.
', 'ListLambdaFunctionsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListLexBotsRequest$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.
', 'ListLexBotsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListPhoneNumbersRequest$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.
', 'ListPhoneNumbersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListPredefinedAttributesRequest$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.
', 'ListPredefinedAttributesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListPromptsRequest$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.
', 'ListPromptsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListQueueQuickConnectsRequest$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.
', 'ListQueueQuickConnectsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListQueuesRequest$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.
', 'ListQueuesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListQuickConnectsRequest$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.
', 'ListQuickConnectsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRoutingProfileQueuesRequest$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.
', 'ListRoutingProfileQueuesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRoutingProfilesRequest$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.
', 'ListRoutingProfilesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListRulesRequest$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.
', 'ListRulesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListSecurityKeysRequest$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.
', 'ListSecurityKeysResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListSecurityProfileApplicationsRequest$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.
', 'ListSecurityProfileApplicationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListSecurityProfilePermissionsRequest$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.
', 'ListSecurityProfilePermissionsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListSecurityProfilesRequest$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.
', 'ListSecurityProfilesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListTaskTemplatesRequest$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.
It is not expected that you set this because the value returned in the previous response is always null.
If there are additional results, this is the token for the next set of results.
This is always returned as a null in the response.
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.
', 'ListTrafficDistributionGroupUsersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListTrafficDistributionGroupsRequest$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.
', 'ListTrafficDistributionGroupsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListUseCasesRequest$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.
', 'ListUseCasesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListUserHierarchyGroupsRequest$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.
', 'ListUserHierarchyGroupsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListUserProficienciesRequest$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.
', 'ListUserProficienciesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListUsersRequest$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.
', 'ListUsersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'NextToken2500' => [ 'base' => NULL, 'refs' => [ 'GetMetricDataV2Request$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.
', 'GetMetricDataV2Response$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchContactFlowModulesRequest$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.
', 'SearchContactFlowModulesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchContactFlowsRequest$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.
', 'SearchContactFlowsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchHoursOfOperationsRequest$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.
', 'SearchHoursOfOperationsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchPredefinedAttributesRequest$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.
', 'SearchPredefinedAttributesResponse$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.
', 'SearchPromptsRequest$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.
', 'SearchPromptsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchQueuesRequest$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.
', 'SearchQueuesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchQuickConnectsRequest$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.
', 'SearchQuickConnectsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchResourceTagsRequest$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.
', 'SearchResourceTagsResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchRoutingProfilesRequest$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.
', 'SearchRoutingProfilesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchSecurityProfilesRequest$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.
', 'SearchSecurityProfilesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchUsersRequest$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.
', 'SearchUsersResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'NotificationContentType' => [ 'base' => NULL, 'refs' => [ 'SendNotificationActionDefinition$ContentType' => 'Content type format.
', ], ], 'NotificationDeliveryType' => [ 'base' => NULL, 'refs' => [ 'SendNotificationActionDefinition$DeliveryMethod' => 'Notification delivery method.
', ], ], 'NotificationRecipientType' => [ 'base' => 'The type of notification recipient.
', 'refs' => [ 'SendNotificationActionDefinition$Recipient' => 'Notification recipient.
', ], ], 'NullableProficiencyLevel' => [ 'base' => NULL, 'refs' => [ 'AttributeCondition$ProficiencyLevel' => 'The proficiency level of the condition.
', ], ], 'NumberReference' => [ 'base' => 'Information about a reference when the referenceType
is NUMBER
. Otherwise, null.
Information about a reference when the referenceType
is NUMBER
. Otherwise, null.
The property label of the automation.
', ], ], 'NumericQuestionPropertyValueAutomation' => [ 'base' => 'Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME
, CONTACT_DURATION
, AGENT_INTERACTION_DURATION
, CUSTOMER_HOLD_TIME
have a minimum value of 0 and maximum value of 28800.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS
has a minimum value of 0 and maximum value of 1000.
The property value of the automation.
', ], ], 'OperatingSystem' => [ 'base' => NULL, 'refs' => [ 'DeviceInfo$OperatingSystem' => 'Operating system that the participant used for the call.
', ], ], 'Origin' => [ 'base' => NULL, 'refs' => [ 'AssociateApprovedOriginRequest$Origin' => 'The domain to add to your allow list.
', 'DisassociateApprovedOriginRequest$Origin' => 'The domain URL of the integrated application.
', 'OriginsList$member' => NULL, ], ], 'OriginsList' => [ 'base' => NULL, 'refs' => [ 'ListApprovedOriginsResponse$Origins' => 'The approved origins.
', ], ], 'OutboundCallerConfig' => [ 'base' => 'The outbound caller ID name, number, and outbound whisper flow.
', 'refs' => [ 'CreateQueueRequest$OutboundCallerConfig' => 'The outbound caller ID name, number, and outbound whisper flow.
', 'Queue$OutboundCallerConfig' => 'The outbound caller ID name, number, and outbound whisper flow.
', 'UpdateQueueOutboundCallerConfigRequest$OutboundCallerConfig' => 'The outbound caller ID name, number, and outbound whisper flow.
', ], ], 'OutboundCallerIdName' => [ 'base' => NULL, 'refs' => [ 'OutboundCallerConfig$OutboundCallerIdName' => 'The caller ID name.
', ], ], 'OutboundCallsEnabled' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceRequest$OutboundCallsEnabled' => 'Your contact center allows outbound calls.
', 'Instance$OutboundCallsEnabled' => 'Whether outbound calls are enabled.
', 'InstanceSummary$OutboundCallsEnabled' => 'Whether outbound calls are enabled.
', ], ], 'OutboundContactNotPermittedException' => [ 'base' => 'The contact is not permitted.
', 'refs' => [], ], 'OutputTypeNotFoundException' => [ 'base' => 'Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact flow.
', 'refs' => [], ], 'PEM' => [ 'base' => NULL, 'refs' => [ 'AssociateSecurityKeyRequest$Key' => 'A valid security key in PEM format.
', 'SecurityKey$Key' => 'The key of the security key.
', ], ], 'ParticipantCapabilities' => [ 'base' => 'The configuration for the allowed capabilities for participants present over the call.
', 'refs' => [ 'AgentInfo$Capabilities' => NULL, 'AllowedCapabilities$Customer' => 'Information about the customer\'s video sharing capabilities.
', 'AllowedCapabilities$Agent' => 'Information about the agent\'s video sharing capabilities.
', 'Customer$Capabilities' => NULL, ], ], 'ParticipantDetails' => [ 'base' => 'The customer\'s details.
', 'refs' => [ 'NewSessionDetails$ParticipantDetails' => NULL, 'StartChatContactRequest$ParticipantDetails' => 'Information identifying the participant.
', 'StartWebRTCContactRequest$ParticipantDetails' => NULL, ], ], 'ParticipantDetailsToAdd' => [ 'base' => 'The details to add for the participant.
', 'refs' => [ 'CreateParticipantRequest$ParticipantDetails' => 'Information identifying the participant.
The only Valid value for ParticipantRole
is CUSTOM_BOT
.
DisplayName
is Required.
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
', 'RealTimeContactAnalysisSegmentAttachments$ParticipantId' => 'The identifier of the participant.
', 'RealTimeContactAnalysisSegmentEvent$ParticipantId' => 'The identifier of the participant.
', 'RealTimeContactAnalysisSegmentTranscript$ParticipantId' => 'The identifier of the participant.
', 'StartChatContactResponse$ParticipantId' => 'The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
', 'StartWebRTCContactResponse$ParticipantId' => 'The identifier for a contact participant. The ParticipantId
for a contact participant is the same throughout the contact lifecycle.
The role of the participant being added.
', 'RealTimeContactAnalysisSegmentAttachments$ParticipantRole' => 'The role of the participant. For example, is it a customer, agent, or system.
', 'RealTimeContactAnalysisSegmentEvent$ParticipantRole' => 'The role of the participant. For example, is it a customer, agent, or system.
', 'RealTimeContactAnalysisSegmentTranscript$ParticipantRole' => 'The role of the participant. For example, is it a customer, agent, or system.
', 'TranscriptCriteria$ParticipantRole' => 'The participant role in a transcript
', ], ], 'ParticipantTimerAction' => [ 'base' => NULL, 'refs' => [ 'ParticipantTimerValue$ParticipantTimerAction' => 'The timer action. Currently only one value is allowed: Unset
. It deletes a timer.
A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400.
', ], ], 'ParticipantTimerConfiguration' => [ 'base' => 'Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
', 'refs' => [ 'ParticipantTimerConfigList$member' => NULL, ], ], 'ParticipantTimerDurationInMinutes' => [ 'base' => NULL, 'refs' => [ 'ParticipantTimerValue$ParticipantTimerDurationInMinutes' => 'The duration of a timer, in minutes.
', ], ], 'ParticipantTimerType' => [ 'base' => NULL, 'refs' => [ 'ParticipantTimerConfiguration$TimerType' => 'The type of timer. IDLE
indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER
indicates the timer applies to automatically disconnecting a chat participant due to idleness.
The value of the timer. Either the timer action (Unset
to delete the timer), or the duration of the timer in minutes. Only one value can be set.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
', 'refs' => [ 'ParticipantTimerConfiguration$TimerValue' => 'The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
', ], ], 'ParticipantToken' => [ 'base' => NULL, 'refs' => [ 'ParticipantTokenCredentials$ParticipantToken' => 'The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
', 'StartChatContactResponse$ParticipantToken' => 'The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
', 'StartWebRTCContactResponse$ParticipantToken' => 'The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.
', ], ], 'ParticipantTokenCredentials' => [ 'base' => 'The credentials used by the participant.
', 'refs' => [ 'CreateParticipantResponse$ParticipantCredentials' => 'The token used by the chat participant to call CreateParticipantConnection
. The participant token is valid for the lifetime of a chat participant.
The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
', ], ], 'PauseContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'PauseContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'Distribution$Percentage' => 'The percentage of the traffic that is distributed, in increments of 10.
', ], ], 'Permission' => [ 'base' => NULL, 'refs' => [ 'ApplicationPermissions$member' => NULL, ], ], 'PermissionsList' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$Permissions' => 'Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.
', 'ListSecurityProfilePermissionsResponse$Permissions' => 'The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.
', 'UpdateSecurityProfileRequest$Permissions' => 'The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.
', ], ], 'PersistentChat' => [ 'base' => 'Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
', 'refs' => [ 'StartChatContactRequest$PersistentChat' => 'Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
', ], ], 'PhoneNumber' => [ 'base' => NULL, 'refs' => [ 'AvailableNumberSummary$PhoneNumber' => 'The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
The phone number in E.164 format.
', 'PhoneNumberSummary$PhoneNumber' => 'The phone number.
', 'StartOutboundVoiceContactRequest$DestinationPhoneNumber' => 'The phone number of the customer, in E.164 format.
', 'StartOutboundVoiceContactRequest$SourcePhoneNumber' => 'The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
', 'UserIdentityInfo$Mobile' => 'The user\'s mobile number.
', 'UserPhoneConfig$DeskPhoneNumber' => 'The phone number for the user\'s desk phone.
', ], ], 'PhoneNumberCountryCode' => [ 'base' => NULL, 'refs' => [ 'AvailableNumberSummary$PhoneNumberCountryCode' => 'The ISO country code.
', 'ClaimedPhoneNumberSummary$PhoneNumberCountryCode' => 'The ISO country code.
', 'ListPhoneNumbersSummary$PhoneNumberCountryCode' => 'The ISO country code.
', 'PhoneNumberCountryCodes$member' => NULL, 'PhoneNumberSummary$PhoneNumberCountryCode' => 'The ISO country code.
', 'SearchAvailablePhoneNumbersRequest$PhoneNumberCountryCode' => 'The ISO country code.
', ], ], 'PhoneNumberCountryCodes' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersRequest$PhoneNumberCountryCodes' => 'The ISO country code.
', 'ListPhoneNumbersV2Request$PhoneNumberCountryCodes' => 'The ISO country code.
', ], ], 'PhoneNumberDescription' => [ 'base' => NULL, 'refs' => [ 'ClaimPhoneNumberRequest$PhoneNumberDescription' => 'The description of the phone number.
', 'ClaimedPhoneNumberSummary$PhoneNumberDescription' => 'The description of the phone number.
', 'ImportPhoneNumberRequest$PhoneNumberDescription' => 'The description of the phone number.
', 'ListPhoneNumbersSummary$PhoneNumberDescription' => 'The description of the phone number.
', 'UpdatePhoneNumberMetadataRequest$PhoneNumberDescription' => 'The description of the phone number.
', ], ], 'PhoneNumberId' => [ 'base' => NULL, 'refs' => [ 'AssociatePhoneNumberContactFlowRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'ClaimPhoneNumberResponse$PhoneNumberId' => 'A unique identifier for the phone number.
', 'ClaimedPhoneNumberSummary$PhoneNumberId' => 'A unique identifier for the phone number.
', 'DescribePhoneNumberRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'DisassociatePhoneNumberContactFlowRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'ImportPhoneNumberResponse$PhoneNumberId' => 'A unique identifier for the phone number.
', 'ListPhoneNumbersSummary$PhoneNumberId' => 'A unique identifier for the phone number.
', 'OutboundCallerConfig$OutboundCallerIdNumberId' => 'The caller ID number.
', 'PhoneNumberSummary$Id' => 'The identifier of the phone number.
', 'ReleasePhoneNumberRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'UpdatePhoneNumberMetadataRequest$PhoneNumberId' => 'The Amazon Resource Name (ARN) or resource ID of the phone number.
', 'UpdatePhoneNumberRequest$PhoneNumberId' => 'A unique identifier for the phone number.
', 'UpdatePhoneNumberResponse$PhoneNumberId' => 'A unique identifier for the phone number.
', ], ], 'PhoneNumberPrefix' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersV2Request$PhoneNumberPrefix' => 'The prefix of the phone number. If provided, it must contain +
as part of the country code.
The prefix of the phone number. If provided, it must contain +
as part of the country code.
Contains information about a phone number for a quick connect.
', 'refs' => [ 'QuickConnectConfig$PhoneConfig' => 'The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
', ], ], 'PhoneNumberStatus' => [ 'base' => 'The status of the phone number.
CLAIMED
means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
IN_PROGRESS
means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
FAILED
indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn
value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED
status from a ClaimPhoneNumber
API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
The status of the phone number.
CLAIMED
means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
IN_PROGRESS
means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
FAILED
indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn
value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED
status from a ClaimPhoneNumber
API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
You will not be billed for the phone number during the 1-day period if number claiming fails.
Contains summary information about a phone number for a contact center.
', 'refs' => [ 'PhoneNumberSummaryList$member' => NULL, ], ], 'PhoneNumberSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersResponse$PhoneNumberSummaryList' => 'Information about the phone numbers.
', ], ], 'PhoneNumberType' => [ 'base' => NULL, 'refs' => [ 'AvailableNumberSummary$PhoneNumberType' => 'The type of phone number.
', 'ClaimedPhoneNumberSummary$PhoneNumberType' => 'The type of phone number.
', 'ListPhoneNumbersSummary$PhoneNumberType' => 'The type of phone number.
', 'PhoneNumberSummary$PhoneNumberType' => 'The type of phone number.
', 'PhoneNumberTypes$member' => NULL, 'SearchAvailablePhoneNumbersRequest$PhoneNumberType' => 'The type of phone number.
', ], ], 'PhoneNumberTypes' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersRequest$PhoneNumberTypes' => 'The type of phone number.
We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN
, SHARED
, THIRD_PARTY_TF
, and THIRD_PARTY_DID
, it incorrectly lists them as TOLL_FREE
or DID
.
The type of phone number.
', ], ], 'PhoneNumberWorkflowMessage' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberStatus$Message' => 'The status message.
', ], ], 'PhoneNumberWorkflowStatus' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberStatus$Status' => 'The status.
', ], ], 'PhoneType' => [ 'base' => NULL, 'refs' => [ 'UserPhoneConfig$PhoneType' => 'The phone type.
', ], ], 'PlatformName' => [ 'base' => NULL, 'refs' => [ 'DeviceInfo$PlatformName' => 'Name of the platform that the participant used for the call.
', ], ], 'PlatformVersion' => [ 'base' => NULL, 'refs' => [ 'DeviceInfo$PlatformVersion' => 'Version of the platform that the participant used for the call.
', ], ], 'PotentialAudioQualityIssue' => [ 'base' => NULL, 'refs' => [ 'PotentialAudioQualityIssues$member' => NULL, ], ], 'PotentialAudioQualityIssues' => [ 'base' => NULL, 'refs' => [ 'AudioQualityMetricsInfo$PotentialQualityIssues' => 'List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss
| HighRoundTripTime
| HighJitterBuffer
Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
', ], ], 'PredefinedAttribute' => [ 'base' => 'Information about a predefined attribute.
', 'refs' => [ 'DescribePredefinedAttributeResponse$PredefinedAttribute' => 'Information about the predefined attribute.
', 'PredefinedAttributeSearchSummaryList$member' => NULL, ], ], 'PredefinedAttributeName' => [ 'base' => NULL, 'refs' => [ 'AttributeCondition$Name' => 'The name of predefined attribute.
', 'CreatePredefinedAttributeRequest$Name' => 'The name of the predefined attribute.
', 'DeletePredefinedAttributeRequest$Name' => 'The name of the predefined attribute.
', 'DescribePredefinedAttributeRequest$Name' => 'The name of the predefined attribute.
', 'PredefinedAttribute$Name' => 'The name of the predefined attribute.
', 'PredefinedAttributeSummary$Name' => 'The name of the predefined attribute.
', 'UpdatePredefinedAttributeRequest$Name' => 'The name of the predefined attribute.
', 'UserProficiency$AttributeName' => 'The name of user\'s proficiency. You must use name of predefined attribute present in the Amazon Connect instance.
', 'UserProficiencyDisassociate$AttributeName' => 'The name of user\'s proficiency.
', ], ], 'PredefinedAttributeSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'PredefinedAttributeSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return predefined attributes.
', 'refs' => [ 'PredefinedAttributeSearchConditionList$member' => NULL, 'SearchPredefinedAttributesRequest$SearchCriteria' => 'The search criteria to be used to return predefined attributes.
', ], ], 'PredefinedAttributeSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchPredefinedAttributesResponse$PredefinedAttributes' => 'Predefined attributes matched by the search criteria.
', ], ], 'PredefinedAttributeStringValue' => [ 'base' => NULL, 'refs' => [ 'PredefinedAttributeStringValuesList$member' => NULL, 'UserProficiency$AttributeValue' => 'The value of user\'s proficiency. You must use value of predefined attribute present in the Amazon Connect instance.
', 'UserProficiencyDisassociate$AttributeValue' => 'The value of user\'s proficiency.
', ], ], 'PredefinedAttributeStringValuesList' => [ 'base' => NULL, 'refs' => [ 'PredefinedAttributeValues$StringList' => 'Predefined attribute values of type string list.
', ], ], 'PredefinedAttributeSummary' => [ 'base' => 'Summary of a predefined attribute.
', 'refs' => [ 'PredefinedAttributeSummaryList$member' => NULL, ], ], 'PredefinedAttributeSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPredefinedAttributesResponse$PredefinedAttributeSummaryList' => 'Summary of the predefined attributes.
', ], ], 'PredefinedAttributeValues' => [ 'base' => 'Information about values of a predefined attribute.
', 'refs' => [ 'CreatePredefinedAttributeRequest$Values' => 'The values of the predefined attribute.
', 'PredefinedAttribute$Values' => 'The values of the predefined attribute.
', 'UpdatePredefinedAttributeRequest$Values' => 'The values of the predefined attribute.
', ], ], 'Prefix' => [ 'base' => NULL, 'refs' => [ 'KinesisVideoStreamConfig$Prefix' => 'The prefix of the video stream.
', 'S3Config$BucketPrefix' => 'The S3 bucket prefix.
', ], ], 'Priority' => [ 'base' => NULL, 'refs' => [ 'RoutingProfileQueueConfig$Priority' => 'The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
', 'RoutingProfileQueueConfigSummary$Priority' => 'The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
', ], ], 'ProblemDetail' => [ 'base' => 'Information about a problem detail.
', 'refs' => [ 'Problems$member' => NULL, ], ], 'ProblemMessageString' => [ 'base' => NULL, 'refs' => [ 'ProblemDetail$message' => 'The problem detail\'s message.
', ], ], 'Problems' => [ 'base' => NULL, 'refs' => [ 'InvalidContactFlowException$problems' => 'The problems with the flow. Please fix before trying again.
', 'InvalidContactFlowModuleException$Problems' => NULL, ], ], 'ProficiencyLevel' => [ 'base' => NULL, 'refs' => [ 'UserProficiency$Level' => 'The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
', ], ], 'ProficiencyValue' => [ 'base' => NULL, 'refs' => [ 'AttributeCondition$Value' => 'The value of predefined attribute.
', ], ], 'Prompt' => [ 'base' => 'Information about a prompt.
', 'refs' => [ 'DescribePromptResponse$Prompt' => 'Information about the prompt.
', 'PromptList$member' => NULL, ], ], 'PromptDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePromptRequest$Description' => 'The description of the prompt.
', 'Prompt$Description' => 'The description of the prompt.
', 'UpdatePromptRequest$Description' => 'A description of the prompt.
', ], ], 'PromptId' => [ 'base' => NULL, 'refs' => [ 'CreatePromptResponse$PromptId' => 'A unique identifier for the prompt.
', 'DeletePromptRequest$PromptId' => 'A unique identifier for the prompt.
', 'DescribePromptRequest$PromptId' => 'A unique identifier for the prompt.
', 'GetPromptFileRequest$PromptId' => 'A unique identifier for the prompt.
', 'Prompt$PromptId' => 'A unique identifier for the prompt.
', 'PromptSummary$Id' => 'The identifier of the prompt.
', 'UpdatePromptRequest$PromptId' => 'A unique identifier for the prompt.
', 'UpdatePromptResponse$PromptId' => 'A unique identifier for the prompt.
', ], ], 'PromptList' => [ 'base' => NULL, 'refs' => [ 'SearchPromptsResponse$Prompts' => 'Information about the prompts.
', ], ], 'PromptName' => [ 'base' => NULL, 'refs' => [ 'PromptSummary$Name' => 'The name of the prompt.
', ], ], 'PromptPresignedUrl' => [ 'base' => NULL, 'refs' => [ 'GetPromptFileResponse$PromptPresignedUrl' => 'A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.
', ], ], 'PromptSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'PromptSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'PromptSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'PromptSearchCriteria' => [ 'base' => 'The search criteria to be used to return prompts.
', 'refs' => [ 'PromptSearchConditionList$member' => NULL, 'SearchPromptsRequest$SearchCriteria' => 'The search criteria to be used to return prompts.
', ], ], 'PromptSearchFilter' => [ 'base' => 'Filters to be applied to search results.
', 'refs' => [ 'SearchPromptsRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'PromptSummary' => [ 'base' => 'Contains information about the prompt.
', 'refs' => [ 'PromptSummaryList$member' => NULL, ], ], 'PromptSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPromptsResponse$PromptSummaryList' => 'Information about the prompts.
', ], ], 'PropertyValidationException' => [ 'base' => 'The property is not valid.
', 'refs' => [], ], 'PropertyValidationExceptionProperty' => [ 'base' => 'Contains information about why a property is not valid.
', 'refs' => [ 'PropertyValidationExceptionPropertyList$member' => NULL, ], ], 'PropertyValidationExceptionPropertyList' => [ 'base' => NULL, 'refs' => [ 'PropertyValidationException$PropertyList' => NULL, ], ], 'PropertyValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'PropertyValidationExceptionProperty$Reason' => 'Why the property is not valid.
', ], ], 'PutUserStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutUserStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'QualityMetrics' => [ 'base' => 'Information about the quality of the participant\'s media connection.
', 'refs' => [ 'Contact$QualityMetrics' => 'Information about the quality of the participant\'s media connection.
', ], ], 'Queue' => [ 'base' => 'Contains information about a queue.
', 'refs' => [ 'DescribeQueueResponse$Queue' => 'The name of the queue.
', 'QueueSearchSummaryList$member' => NULL, ], ], 'QueueDescription' => [ 'base' => NULL, 'refs' => [ 'CreateQueueRequest$Description' => 'The description of the queue.
', 'Queue$Description' => 'The description of the queue.
', 'UpdateQueueNameRequest$Description' => 'The description of the queue.
', ], ], 'QueueId' => [ 'base' => NULL, 'refs' => [ 'AssociateQueueQuickConnectsRequest$QueueId' => 'The identifier for the queue.
', 'AssociatedQueueIdList$member' => NULL, 'ContactDataRequest$QueueId' => 'The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.
', 'ContactSearchSummaryQueueInfo$Id' => 'The unique identifier for the queue.
', 'CreateQueueResponse$QueueId' => 'The identifier for the queue.
', 'CreateRoutingProfileRequest$DefaultOutboundQueueId' => 'The default outbound queue for the routing profile.
', 'DeleteQueueRequest$QueueId' => 'The identifier for the queue.
', 'DescribeQueueRequest$QueueId' => 'The identifier for the queue.
', 'DisassociateQueueQuickConnectsRequest$QueueId' => 'The identifier for the queue.
', 'ListQueueQuickConnectsRequest$QueueId' => 'The identifier for the queue.
', 'Queue$QueueId' => 'The identifier for the queue.
', 'QueueIdList$member' => NULL, 'QueueInfo$Id' => 'The unique identifier for the queue.
', 'QueueQuickConnectConfig$QueueId' => 'The identifier for the queue.
', 'QueueReference$Id' => 'The identifier of the queue.
', 'QueueSummary$Id' => 'The identifier of the queue.
', 'Queues$member' => NULL, 'RoutingProfile$DefaultOutboundQueueId' => 'The identifier of the default outbound queue for this routing profile.
', 'RoutingProfileQueueConfigSummary$QueueId' => 'The identifier for the queue.
', 'RoutingProfileQueueReference$QueueId' => 'The identifier for the queue.
', 'StartOutboundVoiceContactRequest$QueueId' => 'The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.
', 'TransferContactRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueHoursOfOperationRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueMaxContactsRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueNameRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueOutboundCallerConfigRequest$QueueId' => 'The identifier for the queue.
', 'UpdateQueueStatusRequest$QueueId' => 'The identifier for the queue.
', 'UpdateRoutingProfileDefaultOutboundQueueRequest$DefaultOutboundQueueId' => 'The identifier for the default outbound queue.
', ], ], 'QueueIdList' => [ 'base' => NULL, 'refs' => [ 'SearchCriteria$QueueIds' => 'The list of queue IDs associated with contacts.
', ], ], 'QueueInfo' => [ 'base' => 'If this contact was queued, this contains information about the queue.
', 'refs' => [ 'Contact$QueueInfo' => 'If this contact was queued, this contains information about the queue.
', ], ], 'QueueMaxContacts' => [ 'base' => NULL, 'refs' => [ 'CreateQueueRequest$MaxContacts' => 'The maximum number of contacts that can be in the queue before it is considered full.
', 'Queue$MaxContacts' => 'The maximum number of contacts that can be in the queue before it is considered full.
', 'UpdateQueueMaxContactsRequest$MaxContacts' => 'The maximum number of contacts that can be in the queue before it is considered full.
', ], ], 'QueueName' => [ 'base' => NULL, 'refs' => [ 'QueueSummary$Name' => 'The name of the queue.
', 'RoutingProfileQueueConfigSummary$QueueName' => 'The name of the queue.
', ], ], 'QueuePriority' => [ 'base' => NULL, 'refs' => [ 'Contact$QueuePriority' => 'An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
', 'UpdateContactRoutingDataRequest$QueuePriority' => 'Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.
', ], ], 'QueueQuickConnectConfig' => [ 'base' => 'Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
', 'refs' => [ 'QuickConnectConfig$QueueConfig' => 'The queue configuration. This is required only if QuickConnectType is QUEUE.
', ], ], 'QueueReference' => [ 'base' => 'Contains information about a queue resource for which metrics are returned.
', 'refs' => [ 'AgentContactReference$Queue' => NULL, 'Dimensions$Queue' => 'Information about the queue for which metrics are returned.
', ], ], 'QueueSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'QueueSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'QueueSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'QueueSearchCriteria' => [ 'base' => 'The search criteria to be used to return queues.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return queues.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
', 'refs' => [ 'SearchQueuesRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'QueueSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchQueuesResponse$Queues' => 'Information about the queues.
', ], ], 'QueueStatus' => [ 'base' => NULL, 'refs' => [ 'Queue$Status' => 'The status of the queue.
', 'UpdateQueueStatusRequest$Status' => 'The status of the queue.
', ], ], 'QueueSummary' => [ 'base' => 'Contains summary information about a queue.
', 'refs' => [ 'QueueSummaryList$member' => NULL, ], ], 'QueueSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListQueuesResponse$QueueSummaryList' => 'Information about the queues.
', ], ], 'QueueTimeAdjustmentSeconds' => [ 'base' => NULL, 'refs' => [ 'Contact$QueueTimeAdjustmentSeconds' => 'An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
', 'UpdateContactRoutingDataRequest$QueueTimeAdjustmentSeconds' => 'The number of seconds to add or subtract from the contact\'s routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.
', ], ], 'QueueType' => [ 'base' => NULL, 'refs' => [ 'QueueSummary$QueueType' => 'The type of queue.
', 'QueueTypes$member' => NULL, ], ], 'QueueTypes' => [ 'base' => NULL, 'refs' => [ 'ListQueuesRequest$QueueTypes' => 'The type of queue.
', ], ], 'Queues' => [ 'base' => NULL, 'refs' => [ 'Filters$Queues' => 'The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData
API in particular requires a queue when you include a Filter
in your request.
A list of up to 100 queues or ARNs.
', ], ], 'QuickConnect' => [ 'base' => 'Contains information about a quick connect.
', 'refs' => [ 'DescribeQuickConnectResponse$QuickConnect' => 'Information about the quick connect.
', 'QuickConnectSearchSummaryList$member' => NULL, ], ], 'QuickConnectConfig' => [ 'base' => 'Contains configuration settings for a quick connect.
', 'refs' => [ 'CreateQuickConnectRequest$QuickConnectConfig' => 'Configuration settings for the quick connect.
', 'QuickConnect$QuickConnectConfig' => 'Contains information about the quick connect.
', 'UpdateQuickConnectConfigRequest$QuickConnectConfig' => 'Information about the configuration settings for the quick connect.
', ], ], 'QuickConnectDescription' => [ 'base' => NULL, 'refs' => [ 'CreateQuickConnectRequest$Description' => 'The description of the quick connect.
', 'QuickConnect$Description' => 'The description.
', ], ], 'QuickConnectId' => [ 'base' => NULL, 'refs' => [ 'CreateQuickConnectResponse$QuickConnectId' => 'The identifier for the quick connect.
', 'DeleteQuickConnectRequest$QuickConnectId' => 'The identifier for the quick connect.
', 'DescribeQuickConnectRequest$QuickConnectId' => 'The identifier for the quick connect.
', 'QuickConnect$QuickConnectId' => 'The identifier for the quick connect.
', 'QuickConnectSummary$Id' => 'The identifier for the quick connect.
', 'QuickConnectsList$member' => NULL, 'StartTaskContactRequest$QuickConnectId' => 'The identifier for the quick connect. Tasks that are created by using QuickConnectId
will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
The identifier for the quick connect.
', 'UpdateQuickConnectNameRequest$QuickConnectId' => 'The identifier for the quick connect.
', ], ], 'QuickConnectName' => [ 'base' => NULL, 'refs' => [ 'CreateQuickConnectRequest$Name' => 'A unique name of the quick connect.
', 'QuickConnect$Name' => 'The name of the quick connect.
', 'QuickConnectSummary$Name' => 'The name of the quick connect.
', 'UpdateQuickConnectNameRequest$Name' => 'The name of the quick connect.
', ], ], 'QuickConnectSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'QuickConnectSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'QuickConnectSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'QuickConnectSearchCriteria' => [ 'base' => 'The search criteria to be used to return quick connects.
', 'refs' => [ 'QuickConnectSearchConditionList$member' => NULL, 'SearchQuickConnectsRequest$SearchCriteria' => 'The search criteria to be used to return quick connects.
', ], ], 'QuickConnectSearchFilter' => [ 'base' => 'Filters to be applied to search results.
', 'refs' => [ 'SearchQuickConnectsRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'QuickConnectSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchQuickConnectsResponse$QuickConnects' => 'Information about the quick connects.
', ], ], 'QuickConnectSummary' => [ 'base' => 'Contains summary information about a quick connect.
', 'refs' => [ 'QuickConnectSummaryList$member' => NULL, ], ], 'QuickConnectSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListQueueQuickConnectsResponse$QuickConnectSummaryList' => 'Information about the quick connects.
', 'ListQuickConnectsResponse$QuickConnectSummaryList' => 'Information about the quick connects.
', ], ], 'QuickConnectType' => [ 'base' => NULL, 'refs' => [ 'QuickConnectConfig$QuickConnectType' => 'The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
', 'QuickConnectSummary$QuickConnectType' => 'The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
', 'QuickConnectTypes$member' => NULL, ], ], 'QuickConnectTypes' => [ 'base' => NULL, 'refs' => [ 'ListQuickConnectsRequest$QuickConnectTypes' => 'The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
', ], ], 'QuickConnectsList' => [ 'base' => NULL, 'refs' => [ 'AssociateQueueQuickConnectsRequest$QuickConnectIds' => 'The quick connects to associate with this queue.
', 'CreateQueueRequest$QuickConnectIds' => 'The quick connects available to agents who are working the queue.
', 'DisassociateQueueQuickConnectsRequest$QuickConnectIds' => 'The quick connects to disassociate from the queue.
', ], ], 'ReadOnlyFieldInfo' => [ 'base' => 'Indicates a field that is read-only to an agent.
', 'refs' => [ 'ReadOnlyTaskTemplateFields$member' => NULL, ], ], 'ReadOnlyTaskTemplateFields' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateConstraints$ReadOnlyFields' => 'Lists the fields that are read-only to agents, and cannot be edited.
', ], ], 'RealTimeContactAnalysisAttachment' => [ 'base' => 'Object that describes attached file.
', 'refs' => [ 'RealTimeContactAnalysisAttachments$member' => NULL, ], ], 'RealTimeContactAnalysisAttachments' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentAttachments$Attachments' => 'List of objects describing an individual attachment.
', ], ], 'RealTimeContactAnalysisCategoryDetails' => [ 'base' => 'Provides information about the category rule that was matched.
', 'refs' => [ 'RealTimeContactAnalysisMatchedDetails$value' => NULL, ], ], 'RealTimeContactAnalysisCategoryName' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisMatchedDetails$key' => NULL, ], ], 'RealTimeContactAnalysisCharacterInterval' => [ 'base' => 'Begin and end offsets for a part of text.
', 'refs' => [ 'RealTimeContactAnalysisCharacterIntervals$member' => NULL, 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets$CharacterOffsets' => 'List of character intervals within transcript content/text.
', 'RealTimeContactAnalysisTranscriptItemWithContent$CharacterOffsets' => NULL, ], ], 'RealTimeContactAnalysisCharacterIntervals' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisTranscriptItemRedaction$CharacterOffsets' => 'List of character intervals each describing a part of the text that was redacted. For OutputType.Raw
, part of the original text that contains data that can be redacted. For OutputType.Redacted
, part of the string with redaction tag.
The type of content of the item. For example, text/plain
.
Type of the event. For example, application/vnd.amazonaws.connect.event.participant.left
.
The identifier of the segment.
', 'RealTimeContactAnalysisSegmentEvent$Id' => 'The identifier of the contact event.
', 'RealTimeContactAnalysisSegmentTranscript$Id' => 'The identifier of the transcript.
', 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets$Id' => 'Transcript identifier. Matches the identifier from one of the TranscriptSegments.
', 'RealTimeContactAnalysisTranscriptItemWithContent$Id' => 'Transcript identifier. Matches the identifier from one of the TranscriptSegments.
', ], ], 'RealTimeContactAnalysisIssueDetected' => [ 'base' => 'Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
', 'refs' => [ 'RealTimeContactAnalysisIssuesDetected$member' => NULL, ], ], 'RealTimeContactAnalysisIssuesDetected' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentIssues$IssuesDetected' => 'List of the issues detected.
', ], ], 'RealTimeContactAnalysisMatchedDetails' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentCategories$MatchedDetails' => 'Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.
', ], ], 'RealTimeContactAnalysisOffset' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisCharacterInterval$BeginOffsetChar' => 'The beginning of the character interval.
', 'RealTimeContactAnalysisCharacterInterval$EndOffsetChar' => 'The end of the character interval.
', ], ], 'RealTimeContactAnalysisOutputType' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Request$OutputType' => 'The Contact Lens output type to be returned.
', ], ], 'RealTimeContactAnalysisPointOfInterest' => [ 'base' => 'The section of the contact transcript segment that category rule was detected.
', 'refs' => [ 'RealTimeContactAnalysisPointsOfInterest$member' => NULL, ], ], 'RealTimeContactAnalysisPointsOfInterest' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisCategoryDetails$PointsOfInterest' => 'List of PointOfInterest - objects describing a single match of a rule.
', ], ], 'RealTimeContactAnalysisSegmentAttachments' => [ 'base' => 'Segment containing list of attachments.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Attachments' => 'The analyzed attachments.
', ], ], 'RealTimeContactAnalysisSegmentCategories' => [ 'base' => 'The matched category rules.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Categories' => NULL, ], ], 'RealTimeContactAnalysisSegmentEvent' => [ 'base' => 'Segment type describing a contact event.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Event' => NULL, ], ], 'RealTimeContactAnalysisSegmentIssues' => [ 'base' => 'Segment type containing a list of detected issues.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Issues' => NULL, ], ], 'RealTimeContactAnalysisSegmentTranscript' => [ 'base' => 'The analyzed transcript segment.
', 'refs' => [ 'RealtimeContactAnalysisSegment$Transcript' => NULL, ], ], 'RealTimeContactAnalysisSegmentType' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentTypes$member' => NULL, ], ], 'RealTimeContactAnalysisSegmentTypes' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Request$SegmentTypes' => 'Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.
', ], ], 'RealTimeContactAnalysisSentimentLabel' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentTranscript$Sentiment' => 'The sentiment detected for this piece of transcript.
', ], ], 'RealTimeContactAnalysisStatus' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Response$Status' => 'Status of real-time contact analysis.
', ], ], 'RealTimeContactAnalysisSupportedChannel' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Response$Channel' => 'The channel of the contact. Voice
will not be returned.
Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime
', 'refs' => [ 'RealTimeContactAnalysisSegmentAttachments$Time' => 'Field describing the time of the event. It can have different representations of time.
', 'RealTimeContactAnalysisSegmentEvent$Time' => 'Field describing the time of the event. It can have different representations of time.
', 'RealTimeContactAnalysisSegmentTranscript$Time' => 'Field describing the time of the event. It can have different representations of time.
', ], ], 'RealTimeContactAnalysisTimeInstant' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisTimeData$AbsoluteTime' => 'Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
', ], ], 'RealTimeContactAnalysisTranscriptContent' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisSegmentTranscript$Content' => 'The content of the transcript. Can be redacted.
', 'RealTimeContactAnalysisTranscriptItemWithContent$Content' => 'Part of the transcript content that contains identified issue. Can be redacted
', ], ], 'RealTimeContactAnalysisTranscriptItemRedaction' => [ 'base' => 'Object describing redaction applied to the segment.
', 'refs' => [ 'RealTimeContactAnalysisSegmentTranscript$Redaction' => 'Object describing redaction that was applied to the transcript. If transcript has the field it means part of the transcript was redacted.
', ], ], 'RealTimeContactAnalysisTranscriptItemWithCharacterOffsets' => [ 'base' => 'Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a RealTimeContactAnalysisPointOfInterest
in Category.MatchedDetails
would have character interval describing part of the text that matched category.
Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from.
', 'refs' => [ 'RealTimeContactAnalysisTranscriptItemsWithContent$member' => NULL, ], ], 'RealTimeContactAnalysisTranscriptItemsWithCharacterOffsets' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisPointOfInterest$TranscriptItems' => 'List of the transcript items (segments) that are associated with a given point of interest.
', ], ], 'RealTimeContactAnalysisTranscriptItemsWithContent' => [ 'base' => NULL, 'refs' => [ 'RealTimeContactAnalysisIssueDetected$TranscriptItems' => 'List of the transcript items (segments) that are associated with a given issue.
', ], ], 'RealtimeContactAnalysisSegment' => [ 'base' => 'An analyzed segment for a real-time analysis session.
', 'refs' => [ 'RealtimeContactAnalysisSegments$member' => NULL, ], ], 'RealtimeContactAnalysisSegments' => [ 'base' => NULL, 'refs' => [ 'ListRealtimeContactAnalysisSegmentsV2Response$Segments' => 'An analyzed transcript or category.
', ], ], 'Reference' => [ 'base' => 'Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
', 'refs' => [ 'ContactReferences$value' => NULL, ], ], 'ReferenceId' => [ 'base' => NULL, 'refs' => [ 'EvaluationFormQuestion$RefId' => 'The identifier of the question. An identifier must be unique within the evaluation form.
', 'EvaluationFormSection$RefId' => 'The identifier of the section. An identifier must be unique within the evaluation form.
', 'EvaluationFormSingleSelectQuestionAutomation$DefaultOptionRefId' => 'The identifier of the default answer option, when none of the automation options match the criteria.
', 'EvaluationFormSingleSelectQuestionOption$RefId' => 'The identifier of the answer option. An identifier must be unique within the question.
', 'SingleSelectQuestionRuleCategoryAutomation$OptionRefId' => 'The identifier of the answer option.
', ], ], 'ReferenceKey' => [ 'base' => NULL, 'refs' => [ 'AttachmentReference$Name' => 'Identifier of the attachment reference.
', 'ContactReferences$key' => NULL, 'DateReference$Name' => 'Identifier of the date reference.
', 'EmailReference$Name' => 'Identifier of the email reference.
', 'NumberReference$Name' => 'Identifier of the number reference.
', 'StringReference$Name' => 'Identifier of the string reference.
', 'UrlReference$Name' => 'Identifier of the URL reference.
', ], ], 'ReferenceStatus' => [ 'base' => NULL, 'refs' => [ 'AttachmentReference$Status' => 'Status of the attachment reference type.
', ], ], 'ReferenceSummary' => [ 'base' => 'Contains summary information about a reference. ReferenceSummary
contains only one non null field between the URL and attachment based on the reference type.
Information about the flows.
', ], ], 'ReferenceType' => [ 'base' => NULL, 'refs' => [ 'Reference$Type' => 'The type of the reference. DATE
must be of type Epoch timestamp.
The type of reference.
', ], ], 'ReferenceValue' => [ 'base' => NULL, 'refs' => [ 'AttachmentReference$Value' => 'The location path of the attachment reference.
', 'DateReference$Value' => 'A valid date.
', 'EmailReference$Value' => 'A valid email address.
', 'NumberReference$Value' => 'A valid number.
', 'Reference$Value' => 'A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
', 'StringReference$Value' => 'A valid string.
', 'UrlReference$Value' => 'A valid URL.
', ], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'AgentStatusSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'GetPromptFileResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HierarchyGroup$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HierarchyGroupSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HierarchyLevel$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HoursOfOperation$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'HoursOfOperationSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListQueueQuickConnectsResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListRoutingProfileQueuesResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListSecurityProfileApplicationsResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListSecurityProfilePermissionsResponse$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'ListUserProficienciesResponse$LastModifiedRegion' => 'The region in which a user\'s proficiencies were last modified.
', 'PredefinedAttribute$LastModifiedRegion' => 'Last modified region.
', 'PredefinedAttributeSummary$LastModifiedRegion' => 'Last modified region.
', 'Prompt$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'PromptSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'Queue$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'QueueSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'QuickConnect$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'QuickConnectSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'RoutingProfile$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'RoutingProfileSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'SecurityProfile$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'SecurityProfileSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'User$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', 'UserSummary$LastModifiedRegion' => 'The Amazon Web Services Region where this resource was last modified.
', ], ], 'RehydrationType' => [ 'base' => NULL, 'refs' => [ 'CreatePersistentContactAssociationRequest$RehydrationType' => 'The contactId chosen for rehydration depends on the type chosen.
ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId
of the past ended chat session in the sourceContactId
field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.
FROM_SEGMENT
: Rehydrates a chat from the specified past chat contact provided in the sourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:
Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:
Configuration
SourceContactId = "C2"
RehydrationType = "FROM_SEGMENT"
Expected behavior
This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.
Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:
Configuration
SourceContactId = "C1"
RehydrationType = "ENTIRE_PAST_SESSION"
Expected behavior
This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId
of the past ended chat session in the sourceContactId
field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat.
FROM_SEGMENT
: Rehydrates a chat from the past chat contact that is specified in the sourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
', ], ], 'ReleasePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReplicateInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ReplicateInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RequestIdentifier' => [ 'base' => NULL, 'refs' => [ 'ContactDataRequest$RequestIdentifier' => 'Identifier to uniquely identify individual requests in the batch.
', 'FailedRequest$RequestIdentifier' => 'Request identifier provided in the API call in the ContactDataRequest to create a contact.
', 'SuccessfulRequest$RequestIdentifier' => 'Request identifier provided in the API call in the ContactDataRequest to create a contact.
', ], ], 'RequiredFieldInfo' => [ 'base' => 'Information about a required field.
', 'refs' => [ 'RequiredTaskTemplateFields$member' => NULL, ], ], 'RequiredTaskTemplateFields' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateConstraints$RequiredFields' => 'Lists the fields that are required to be filled by agents.
', ], ], 'ResourceArnOrId' => [ 'base' => NULL, 'refs' => [ 'FilterV2$FilterKey' => 'The key to use for filtering data. For example, QUEUE
, ROUTING_PROFILE, AGENT
, CHANNEL
, AGENT_HIERARCHY_LEVEL_ONE
, AGENT_HIERARCHY_LEVEL_TWO
, AGENT_HIERARCHY_LEVEL_THREE
, AGENT_HIERARCHY_LEVEL_FOUR
, AGENT_HIERARCHY_LEVEL_FIVE
. There must be at least 1 key and a maximum 5 keys.
The type of comparison. Only "less than" (LT) comparisons are supported.
', ], ], 'ResourceConflictException' => [ 'base' => 'A resource already has that name.
', 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ActivateEvaluationFormRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'ActivateEvaluationFormResponse$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'CreateEvaluationFormResponse$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'DeactivateEvaluationFormRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'DeactivateEvaluationFormResponse$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'DeleteContactEvaluationRequest$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'DeleteEvaluationFormRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'DescribeContactEvaluationRequest$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'DescribeEvaluationFormRequest$EvaluationFormId' => 'A unique identifier for the contact evaluation.
', 'Evaluation$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'EvaluationAnswersInputMap$key' => NULL, 'EvaluationAnswersOutputMap$key' => NULL, 'EvaluationForm$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'EvaluationFormContent$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'EvaluationFormSummary$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'EvaluationFormVersionSummary$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'EvaluationMetadata$ContactAgentId' => 'The identifier of the agent who performed the contact.
', 'EvaluationNotesMap$key' => NULL, 'EvaluationScoresMap$key' => NULL, 'EvaluationSummary$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'EvaluationSummary$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'ListEvaluationFormVersionsRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'StartContactEvaluationRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'StartContactEvaluationResponse$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'SubmitContactEvaluationRequest$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'SubmitContactEvaluationResponse$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'UpdateContactEvaluationRequest$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'UpdateContactEvaluationResponse$EvaluationId' => 'A unique identifier for the contact evaluation.
', 'UpdateEvaluationFormRequest$EvaluationFormId' => 'The unique identifier for the evaluation form.
', 'UpdateEvaluationFormResponse$EvaluationFormId' => 'The unique identifier for the evaluation form.
', ], ], 'ResourceInUseException' => [ 'base' => 'That resource is already in use. Please try another.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource was not found.
', 'refs' => [], ], 'ResourceNotReadyException' => [ 'base' => 'The resource is not ready.
', 'refs' => [], ], 'ResourceTagsSearchCriteria' => [ 'base' => 'The search criteria to be used to search tags.
', 'refs' => [ 'SearchResourceTagsRequest$SearchCriteria' => 'The search criteria to be used to return tags.
', ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceInUseException$ResourceType' => 'The type of resource.
', ], ], 'ResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'SearchResourceTagsRequest$ResourceTypes' => 'The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.
', ], ], 'ResumeContactRecordingRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResumeContactRecordingResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResumeContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResumeContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'RoutingCriteria' => [ 'base' => 'Latest routing criteria on the contact.
', 'refs' => [ 'Contact$RoutingCriteria' => 'Latest routing criteria on the contact.
', ], ], 'RoutingCriteriaStepStatus' => [ 'base' => NULL, 'refs' => [ 'Step$Status' => 'Represents status of the Routing step.
', ], ], 'RoutingExpression' => [ 'base' => NULL, 'refs' => [ 'Dimensions$RoutingStepExpression' => 'The expression of a step in a routing criteria.
', 'RoutingExpressions$member' => NULL, ], ], 'RoutingExpressions' => [ 'base' => NULL, 'refs' => [ 'Filters$RoutingStepExpressions' => 'A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.
', ], ], 'RoutingProfile' => [ 'base' => 'Contains information about a routing profile.
', 'refs' => [ 'DescribeRoutingProfileResponse$RoutingProfile' => 'The routing profile.
', 'RoutingProfileList$member' => NULL, ], ], 'RoutingProfileDescription' => [ 'base' => NULL, 'refs' => [ 'CreateRoutingProfileRequest$Description' => 'Description of the routing profile. Must not be more than 250 characters.
', 'RoutingProfile$Description' => 'The description of the routing profile.
', 'UpdateRoutingProfileNameRequest$Description' => 'The description of the routing profile. Must not be more than 250 characters.
', ], ], 'RoutingProfileId' => [ 'base' => NULL, 'refs' => [ 'AssociateRoutingProfileQueuesRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'CreateRoutingProfileResponse$RoutingProfileId' => 'The identifier of the routing profile.
', 'CreateUserRequest$RoutingProfileId' => 'The identifier of the routing profile for the user.
', 'DeleteRoutingProfileRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'DescribeRoutingProfileRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'DisassociateRoutingProfileQueuesRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'ListRoutingProfileQueuesRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'RoutingProfile$RoutingProfileId' => 'The identifier of the routing profile.
', 'RoutingProfileReference$Id' => 'The identifier of the routing profile.
', 'RoutingProfileSummary$Id' => 'The identifier of the routing profile.
', 'RoutingProfiles$member' => NULL, 'UpdateRoutingProfileAgentAvailabilityTimerRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateRoutingProfileConcurrencyRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateRoutingProfileDefaultOutboundQueueRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateRoutingProfileNameRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateRoutingProfileQueuesRequest$RoutingProfileId' => 'The identifier of the routing profile.
', 'UpdateUserRoutingProfileRequest$RoutingProfileId' => 'The identifier of the routing profile for the user.
', 'User$RoutingProfileId' => 'The identifier of the routing profile for the user.
', 'UserSearchSummary$RoutingProfileId' => 'The identifier of the user\'s routing profile.
', ], ], 'RoutingProfileList' => [ 'base' => NULL, 'refs' => [ 'SearchRoutingProfilesResponse$RoutingProfiles' => 'Information about the routing profiles.
', ], ], 'RoutingProfileName' => [ 'base' => NULL, 'refs' => [ 'CreateRoutingProfileRequest$Name' => 'The name of the routing profile. Must not be more than 127 characters.
', 'RoutingProfile$Name' => 'The name of the routing profile.
', 'RoutingProfileSummary$Name' => 'The name of the routing profile.
', 'UpdateRoutingProfileNameRequest$Name' => 'The name of the routing profile. Must not be more than 127 characters.
', ], ], 'RoutingProfileQueueConfig' => [ 'base' => 'Contains information about the queue and channel for which priority and delay can be set.
', 'refs' => [ 'RoutingProfileQueueConfigList$member' => NULL, ], ], 'RoutingProfileQueueConfigList' => [ 'base' => NULL, 'refs' => [ 'AssociateRoutingProfileQueuesRequest$QueueConfigs' => 'The queues to associate with this routing profile.
', 'CreateRoutingProfileRequest$QueueConfigs' => 'The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig
objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.
The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
', ], ], 'RoutingProfileQueueConfigSummary' => [ 'base' => 'Contains summary information about a routing profile queue.
', 'refs' => [ 'RoutingProfileQueueConfigSummaryList$member' => NULL, ], ], 'RoutingProfileQueueConfigSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListRoutingProfileQueuesResponse$RoutingProfileQueueConfigSummaryList' => 'Information about the routing profiles.
', ], ], 'RoutingProfileQueueReference' => [ 'base' => 'Contains the channel and queue identifier for a routing profile.
', 'refs' => [ 'RoutingProfileQueueConfig$QueueReference' => 'Contains information about a queue resource.
', 'RoutingProfileQueueReferenceList$member' => NULL, ], ], 'RoutingProfileQueueReferenceList' => [ 'base' => NULL, 'refs' => [ 'DisassociateRoutingProfileQueuesRequest$QueueReferences' => 'The queues to disassociate from this routing profile.
', ], ], 'RoutingProfileReference' => [ 'base' => 'Information about the routing profile assigned to the user.
', 'refs' => [ 'Dimensions$RoutingProfile' => NULL, 'UserData$RoutingProfile' => 'Information about the routing profile that is assigned to the user.
', ], ], 'RoutingProfileSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'RoutingProfileSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'RoutingProfileSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'RoutingProfileSearchCriteria' => [ 'base' => 'The search criteria to be used to return routing profiles.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return routing profiles.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
', 'refs' => [ 'SearchRoutingProfilesRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'RoutingProfileSummary' => [ 'base' => 'Contains summary information about a routing profile.
', 'refs' => [ 'RoutingProfileSummaryList$member' => NULL, ], ], 'RoutingProfileSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListRoutingProfilesResponse$RoutingProfileSummaryList' => 'Information about the routing profiles.
', ], ], 'RoutingProfiles' => [ 'base' => NULL, 'refs' => [ 'Filters$RoutingProfiles' => 'A list of up to 100 routing profile IDs or ARNs.
', 'UserDataFilters$RoutingProfiles' => 'A list of up to 100 routing profile IDs or ARNs.
', ], ], 'Rule' => [ 'base' => 'Information about a rule.
', 'refs' => [ 'DescribeRuleResponse$Rule' => 'Information about the rule.
', ], ], 'RuleAction' => [ 'base' => 'Information about the action to be performed when a rule is triggered.
', 'refs' => [ 'RuleActions$member' => NULL, ], ], 'RuleActions' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$Actions' => 'A list of actions to be run when the rule is triggered.
', 'Rule$Actions' => 'A list of actions to be run when the rule is triggered.
', 'UpdateRuleRequest$Actions' => 'A list of actions to be run when the rule is triggered.
', ], ], 'RuleFunction' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$Function' => 'The conditions of the rule.
', 'Rule$Function' => 'The conditions of the rule.
', 'UpdateRuleRequest$Function' => 'The conditions of the rule.
', ], ], 'RuleId' => [ 'base' => NULL, 'refs' => [ 'CreateRuleResponse$RuleId' => 'A unique identifier for the rule.
', 'DeleteRuleRequest$RuleId' => 'A unique identifier for the rule.
', 'DescribeRuleRequest$RuleId' => 'A unique identifier for the rule.
', 'Rule$RuleId' => 'A unique identifier for the rule.
', 'RuleSummary$RuleId' => 'A unique identifier for the rule.
', 'UpdateRuleRequest$RuleId' => 'A unique identifier for the rule.
', ], ], 'RuleName' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$Name' => 'A unique name for the rule.
', 'Rule$Name' => 'The name of the rule.
', 'RuleSummary$Name' => 'The name of the rule.
', 'UpdateRuleRequest$Name' => 'The name of the rule. You can change the name only if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
The publish status of the rule.
', 'ListRulesRequest$PublishStatus' => 'The publish status of the rule.
', 'Rule$PublishStatus' => 'The publish status of the rule.
', 'RuleSummary$PublishStatus' => 'The publish status of the rule.
', 'UpdateRuleRequest$PublishStatus' => 'The publish status of the rule.
', ], ], 'RuleSummary' => [ 'base' => 'A list of ActionTypes
associated with a rule.
Summary information about a rule.
', ], ], 'RuleTriggerEventSource' => [ 'base' => 'The name of the event source. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
| OnContactEvaluationSubmit
| OnMetricDataUpdate
.
The event source to trigger the rule.
', 'Rule$TriggerEventSource' => 'The event source to trigger the rule.
', ], ], 'S3Config' => [ 'base' => 'Information about the Amazon Simple Storage Service (Amazon S3) storage type.
', 'refs' => [ 'InstanceStorageConfig$S3Config' => 'The S3 bucket configuration.
', ], ], 'S3Uri' => [ 'base' => NULL, 'refs' => [ 'CreatePromptRequest$S3Uri' => 'The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
', 'UpdatePromptRequest$S3Uri' => 'The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
', ], ], 'SearchAvailablePhoneNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchAvailablePhoneNumbersResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactFlowModulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactFlowModulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactFlowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactFlowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactsMatchType' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributes$MatchType' => 'The match type combining search criteria using multiple searchable contact attributes.
', 'Transcript$MatchType' => 'The match type combining search criteria using multiple transcript criteria.
', 'TranscriptCriteria$MatchType' => 'The match type combining search criteria using multiple search texts in a transcript criteria.
', ], ], 'SearchContactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchContactsTimeRange' => [ 'base' => 'A structure of time range that you want to search results.
', 'refs' => [ 'SearchContactsRequest$TimeRange' => 'Time range that you want to search results.
', ], ], 'SearchContactsTimeRangeType' => [ 'base' => NULL, 'refs' => [ 'SearchContactsTimeRange$Type' => 'The type of timestamp to search.
', ], ], 'SearchCriteria' => [ 'base' => 'A structure of search criteria to be used to return contacts.
', 'refs' => [ 'SearchContactsRequest$SearchCriteria' => 'The search criteria to be used to return contacts.
', ], ], 'SearchHoursOfOperationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchHoursOfOperationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchPredefinedAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchPredefinedAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchPromptsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchPromptsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchQueuesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchQuickConnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchQuickConnectsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchResourceTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchResourceTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchRoutingProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchRoutingProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchSecurityProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchSecurityProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchText' => [ 'base' => NULL, 'refs' => [ 'SearchTextList$member' => NULL, ], ], 'SearchTextList' => [ 'base' => NULL, 'refs' => [ 'TranscriptCriteria$SearchText' => 'The words or phrases used to search within a transcript.
', ], ], 'SearchUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchVocabulariesRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchVocabulariesResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchableContactAttributeKey' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributesCriteria$Key' => 'The key containing a searchable user-defined contact attribute.
', ], ], 'SearchableContactAttributeValue' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributeValueList$member' => NULL, ], ], 'SearchableContactAttributeValueList' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributesCriteria$Values' => 'The list of values to search for within a user-defined contact attribute.
', ], ], 'SearchableContactAttributes' => [ 'base' => 'A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
', 'refs' => [ 'SearchCriteria$SearchableContactAttributes' => 'The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes
in a search request, the GetContactAttributes
action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
The search criteria based on user-defned contact attribute key and values to search on.
', 'refs' => [ 'SearchableContactAttributesCriteriaList$member' => NULL, ], ], 'SearchableContactAttributesCriteriaList' => [ 'base' => NULL, 'refs' => [ 'SearchableContactAttributes$Criteria' => 'The list of criteria based on user-defined contact attributes that are configured for contact search.
', ], ], 'SearchableQueueType' => [ 'base' => NULL, 'refs' => [ 'QueueSearchCriteria$QueueTypeCondition' => 'The type of queue.
', ], ], 'SecurityKey' => [ 'base' => 'Configuration information of the security key.
', 'refs' => [ 'SecurityKeysList$member' => NULL, ], ], 'SecurityKeysList' => [ 'base' => NULL, 'refs' => [ 'ListSecurityKeysResponse$SecurityKeys' => 'The security keys.
', ], ], 'SecurityProfile' => [ 'base' => 'Contains information about a security profile.
', 'refs' => [ 'DescribeSecurityProfileResponse$SecurityProfile' => 'The security profile.
', ], ], 'SecurityProfileDescription' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileRequest$Description' => 'The description of the security profile.
', 'SecurityProfile$Description' => 'The description of the security profile.
', 'SecurityProfileSearchSummary$Description' => 'The description of the security profile.
', 'UpdateSecurityProfileRequest$Description' => 'The description of the security profile.
', ], ], 'SecurityProfileId' => [ 'base' => NULL, 'refs' => [ 'CreateSecurityProfileResponse$SecurityProfileId' => 'The identifier for the security profle.
', 'DeleteSecurityProfileRequest$SecurityProfileId' => 'The identifier for the security profle.
', 'DescribeSecurityProfileRequest$SecurityProfileId' => 'The identifier for the security profle.
', 'ListSecurityProfileApplicationsRequest$SecurityProfileId' => 'The identifier for the security profle.
', 'ListSecurityProfilePermissionsRequest$SecurityProfileId' => 'The identifier for the security profle.
', 'SecurityProfile$Id' => 'The identifier for the security profile.
', 'SecurityProfileIds$member' => NULL, 'SecurityProfileSearchSummary$Id' => 'The identifier of the security profile.
', 'SecurityProfileSummary$Id' => 'The identifier of the security profile.
', 'UpdateSecurityProfileRequest$SecurityProfileId' => 'The identifier for the security profle.
', ], ], 'SecurityProfileIds' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$SecurityProfileIds' => 'The identifier of the security profile for the user.
', 'UpdateUserSecurityProfilesRequest$SecurityProfileIds' => 'The identifiers of the security profiles for the user.
', 'User$SecurityProfileIds' => 'The identifiers of the security profiles for the user.
', 'UserSearchSummary$SecurityProfileIds' => 'The identifiers of the user\'s security profiles.
', ], ], 'SecurityProfileName' => [ 'base' => NULL, 'refs' => [ 'SecurityProfile$SecurityProfileName' => 'The name for the security profile.
', 'SecurityProfileSearchSummary$SecurityProfileName' => 'The name of the security profile.
', 'SecurityProfileSummary$Name' => 'The name of the security profile.
', ], ], 'SecurityProfilePermission' => [ 'base' => NULL, 'refs' => [ 'PermissionsList$member' => NULL, ], ], 'SecurityProfilePolicyKey' => [ 'base' => NULL, 'refs' => [ 'AllowedAccessControlTags$key' => NULL, ], ], 'SecurityProfilePolicyValue' => [ 'base' => NULL, 'refs' => [ 'AllowedAccessControlTags$value' => NULL, ], ], 'SecurityProfileSearchConditionList' => [ 'base' => NULL, 'refs' => [ 'SecurityProfileSearchCriteria$OrConditions' => 'A list of conditions which would be applied together with an OR condition.
', 'SecurityProfileSearchCriteria$AndConditions' => 'A list of conditions which would be applied together with an AND condition.
', ], ], 'SecurityProfileSearchCriteria' => [ 'base' => 'The search criteria to be used to return security profiles.
The name
field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The search criteria to be used to return security profiles.
The name
field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The currently supported value for FieldName
: name
Information about the returned security profiles.
', 'refs' => [ 'SecurityProfilesSearchSummaryList$member' => NULL, ], ], 'SecurityProfileSummary' => [ 'base' => 'Contains information about a security profile.
', 'refs' => [ 'SecurityProfileSummaryList$member' => NULL, ], ], 'SecurityProfileSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListSecurityProfilesResponse$SecurityProfileSummaryList' => 'Information about the security profiles.
', ], ], 'SecurityProfilesSearchFilter' => [ 'base' => 'Filters to be applied to search results.
', 'refs' => [ 'SearchSecurityProfilesRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'SecurityProfilesSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchSecurityProfilesResponse$SecurityProfiles' => 'Information about the security profiles.
', ], ], 'SecurityToken' => [ 'base' => NULL, 'refs' => [ 'Credentials$AccessToken' => 'An access token generated for a federated user to access Amazon Connect.
', 'Credentials$RefreshToken' => 'Renews a token generated for a user to access the Amazon Connect instance.
', ], ], 'SegmentAttributeName' => [ 'base' => NULL, 'refs' => [ 'SegmentAttributes$key' => NULL, ], ], 'SegmentAttributeValue' => [ 'base' => 'A value for a segment attribute. This is structured as a map where the key is valueString
and the value is a string.
The value of a segment attribute.
', ], ], 'SegmentAttributes' => [ 'base' => NULL, 'refs' => [ 'Contact$SegmentAttributes' => 'A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide
or connect:SMS
.
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide
.
The types application/vnd.amazonaws.connect.message.interactive
and application/vnd.amazonaws.connect.message.interactive.response
must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes
as { "connect:Subtype": {"valueString" : "connect:Guide" }}
.
Information about the send notification action.
', 'refs' => [ 'RuleAction$SendNotificationAction' => 'Information about the send notification action.
Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
| OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
| OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
| OnMetricDataUpdate
The service quota has been exceeded.
', 'refs' => [], ], 'SignInConfig' => [ 'base' => 'The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
', 'refs' => [ 'GetTrafficDistributionResponse$SignInConfig' => 'The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
', 'UpdateTrafficDistributionRequest$SignInConfig' => 'The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
', ], ], 'SignInDistribution' => [ 'base' => 'The distribution of sign in traffic between the instance and its replica(s).
', 'refs' => [ 'SignInDistributionList$member' => NULL, ], ], 'SignInDistributionList' => [ 'base' => NULL, 'refs' => [ 'SignInConfig$Distributions' => 'Information about traffic distributions.
', ], ], 'SingleSelectOptions' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateField$SingleSelectOptions' => 'A list of options for a single select field.
', ], ], 'SingleSelectQuestionRuleCategoryAutomation' => [ 'base' => 'Information about the automation option based on a rule category for a single select question.
', 'refs' => [ 'EvaluationFormSingleSelectQuestionAutomationOption$RuleCategory' => 'The automation option based on a rule category for the single select question.
', ], ], 'SingleSelectQuestionRuleCategoryAutomationCondition' => [ 'base' => NULL, 'refs' => [ 'SingleSelectQuestionRuleCategoryAutomation$Condition' => 'The condition to apply for the automation option. If the condition is PRESENT
, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT
, then the option is applied when the contact data does not include the category.
The category name, as defined in Rules.
', ], ], 'SnapshotVersion' => [ 'base' => NULL, 'refs' => [ 'GetTaskTemplateRequest$SnapshotVersion' => 'The system generated version of a task template that is associated with a task, when the task is created.
', ], ], 'Sort' => [ 'base' => 'A structure that defines the field name to sort by and a sort order.
', 'refs' => [ 'SearchContactsRequest$Sort' => 'Specifies a field to sort by and a sort order.
', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'CurrentMetricSortCriteria$SortOrder' => 'The way to sort.
', 'Sort$Order' => 'An ascending or descending sort.
', ], ], 'SortableFieldName' => [ 'base' => NULL, 'refs' => [ 'Sort$FieldName' => 'The name of the field on which to sort.
', ], ], 'SourceApplicationName' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationRequest$SourceApplicationName' => 'The name of the external application. This field is only required for the EVENT integration type.
', 'IntegrationAssociationSummary$SourceApplicationName' => 'The user-provided, friendly name for the external application.
', ], ], 'SourceId' => [ 'base' => NULL, 'refs' => [ 'SendChatIntegrationEventRequest$SourceId' => 'External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.
', ], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationRequest$SourceType' => 'The type of the data source. This field is only required for the EVENT integration type.
', 'IntegrationAssociationSummary$SourceType' => 'The name of the source.
', ], ], 'StartAttachedFileUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartAttachedFileUploadResponse' => [ 'base' => 'Response from StartAttachedFileUpload API.', 'refs' => [], ], 'StartChatContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartChatContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartContactEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContactEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartContactRecordingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContactRecordingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartContactStreamingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContactStreamingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartOutboundVoiceContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartOutboundVoiceContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTaskContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartWebRTCContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWebRTCContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'HistoricalMetric$Statistic' => 'The statistic for the metric.
', ], ], 'Step' => [ 'base' => 'Step signifies the criteria to be used for routing to an agent
', 'refs' => [ 'Steps$member' => NULL, ], ], 'Steps' => [ 'base' => NULL, 'refs' => [ 'RoutingCriteria$Steps' => 'List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
', ], ], 'StopContactRecordingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopContactRecordingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopContactStreamingRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopContactStreamingResponse' => [ 'base' => NULL, 'refs' => [], ], 'StorageType' => [ 'base' => NULL, 'refs' => [ 'InstanceStorageConfig$StorageType' => 'A valid storage type.
', ], ], 'StreamingId' => [ 'base' => NULL, 'refs' => [ 'StartContactStreamingResponse$StreamingId' => 'The identifier of the streaming configuration enabled.
', 'StopContactStreamingRequest$StreamingId' => 'The identifier of the streaming configuration enabled.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AnalyticsDataAssociationResult$ResourceShareId' => 'The Resource Access Manager share ID.
', 'AssociateAnalyticsDataSetResponse$ResourceShareId' => 'The Resource Access Manager share ID that is generated.
', 'ErrorResult$ErrorCode' => 'The error code.
', 'ErrorResult$ErrorMessage' => 'The corresponding error message for the error code.
', 'FailedRequest$FailureReasonMessage' => 'Why the request to create a contact failed.
', 'HierarchyGroupCondition$Value' => 'The value in the hierarchy group condition.
', 'InstanceStatusReason$Message' => 'The message.
', 'IntervalDetails$TimeZone' => 'The timezone applied to requested metrics.
', 'MetricFilterV2$MetricFilterKey' => 'The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD
, DISCONNECT_REASON
. These are the same values as the InitiationMethod
and DisconnectReason
in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator Guide.
The full property path.
', 'ResourceTypeList$member' => NULL, 'StringCondition$FieldName' => 'The name of the field in the string condition.
', 'StringCondition$Value' => 'The value of the string.
', 'TagCondition$TagKey' => 'The tag key in the tag condition.
', 'TagCondition$TagValue' => 'The tag value in the tag condition.
', 'UserTagMap$key' => NULL, 'UserTagMap$value' => NULL, ], ], 'StringComparisonType' => [ 'base' => NULL, 'refs' => [ 'StringCondition$ComparisonType' => 'The type of comparison to be made when evaluating the string condition.
', 'TagSearchCondition$tagKeyComparisonType' => 'The type of comparison to be made when evaluating the tag key in tag search condition.
', 'TagSearchCondition$tagValueComparisonType' => 'The type of comparison to be made when evaluating the tag value in tag search condition.
', ], ], 'StringCondition' => [ 'base' => 'A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
and description
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, timezone
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are associatedQueueIds
, name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are Username
, FirstName
, LastName
, RoutingProfileId
, SecurityProfileId
, ResourceId
.
Information about a reference when the referenceType
is STRING
. Otherwise, null.
Information about a reference when the referenceType
is STRING
. Otherwise, null.
The subject of the email if the delivery method is EMAIL
. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Information about the submit automated evaluation action.
', 'refs' => [ 'RuleAction$SubmitAutoEvaluationAction' => 'Information about the submit automated evaluation action.
', ], ], 'SubmitContactEvaluationRequest' => [ 'base' => NULL, 'refs' => [], ], 'SubmitContactEvaluationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Subtype' => [ 'base' => NULL, 'refs' => [ 'SendChatIntegrationEventRequest$Subtype' => 'Classification of a channel. This is used in part to uniquely identify chat.
Valid value: ["connect:sms"]
Request for which contact was successfully created.
', 'refs' => [ 'SuccessfulRequestList$member' => NULL, ], ], 'SuccessfulRequestList' => [ 'base' => NULL, 'refs' => [ 'BatchPutContactResponse$SuccessfulRequestList' => 'List of requests for which contact was successfully created.
', ], ], 'SupportedMessagingContentType' => [ 'base' => NULL, 'refs' => [ 'SupportedMessagingContentTypes$member' => NULL, ], ], 'SupportedMessagingContentTypes' => [ 'base' => NULL, 'refs' => [ 'NewSessionDetails$SupportedMessagingContentTypes' => ' The supported chat message content types. Supported types are text/plain
, text/markdown
, application/json
, application/vnd.amazonaws.connect.message.interactive
, and application/vnd.amazonaws.connect.message.interactive.response
.
Content types must always contain text/plain
. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain
: [text/plain, text/markdown, application/json]
, [text/markdown, text/plain]
, [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]
.
The supported chat message content types. Supported types are text/plain
, text/markdown
, application/json
, application/vnd.amazonaws.connect.message.interactive
, and application/vnd.amazonaws.connect.message.interactive.response
.
Content types must always contain text/plain
. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain
: [text/plain, text/markdown, application/json]
, [text/markdown, text/plain]
, [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]
.
The type application/vnd.amazonaws.connect.message.interactive
is required to use the Show view flow block.
A leaf node condition which can be used to specify a tag condition.
', 'ControlPlaneTagFilter$AndConditions' => 'A list of conditions which would be applied together with an AND
condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123
.
A leaf node condition which can be used to specify a tag condition.
', 'ControlPlaneUserAttributeFilter$TagCondition' => NULL, 'TagAndConditionList$member' => NULL, ], ], 'TagContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, 'TagSet$key' => 'The tag key in the tagSet.
', ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The tag keys.
', ], ], 'TagKeyString' => [ 'base' => NULL, 'refs' => [ 'TagSearchCondition$tagKey' => 'The tag key used in the tag search condition.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'AgentStatus$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'AttachedFile$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }
.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'ClaimedPhoneNumberSummary$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'ContactFlow$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'ContactFlowModule$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateAgentStatusRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateContactFlowModuleRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateContactFlowRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateHoursOfOperationRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateInstanceRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }
.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreatePromptRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateQueueRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateQuickConnectRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateRoutingProfileRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateSecurityProfileRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateTrafficDistributionGroupRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateUseCaseRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateUserHierarchyGroupRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateUserRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateViewRequest$Tags' => 'The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
', 'CreateVocabularyRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'Evaluation$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'EvaluationForm$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'GetAttachedFileResponse$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }
.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'HierarchyGroup$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'HoursOfOperation$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'ImportPhoneNumberRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'Instance$Tags' => 'The tags of an instance.
', 'ListTagsForResourceResponse$tags' => 'Information about the tags.
', 'Prompt$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'Queue$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'QuickConnect$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'RoutingProfile$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'Rule$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'SecurityProfile$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'SecurityProfileSearchSummary$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'StartAttachedFileUploadRequest$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }
.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'TrafficDistributionGroup$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'User$Tags' => 'The tags.
', 'UserSearchSummary$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', 'View$Tags' => 'The tags associated with the view resource (not specific to view version).
', 'Vocabulary$Tags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
', ], ], 'TagOrConditionList' => [ 'base' => NULL, 'refs' => [ 'ControlPlaneTagFilter$OrConditions' => 'A list of conditions which would be applied together with an OR
condition.
The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User
| SecurityProfile
| Queue
| RoutingProfile
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
', 'UpdateSecurityProfileRequest$TagRestrictedResources' => 'The list of resources that a security profile applies tag restrictions to in Amazon Connect.
', ], ], 'TagRestrictedResourceName' => [ 'base' => NULL, 'refs' => [ 'TagRestrictedResourceList$member' => NULL, ], ], 'TagSearchCondition' => [ 'base' => 'The search criteria to be used to return tags.
', 'refs' => [ 'ResourceTagsSearchCriteria$TagSearchCondition' => 'The search criteria to be used to return tags.
', ], ], 'TagSet' => [ 'base' => 'A tag set contains tag key and tag value.
', 'refs' => [ 'TagsList$member' => NULL, ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, 'TagSet$value' => 'The tag value in the tagSet.
', ], ], 'TagValueString' => [ 'base' => NULL, 'refs' => [ 'TagSearchCondition$tagValue' => 'The tag value used in the tag search condition.
', ], ], 'TagsList' => [ 'base' => NULL, 'refs' => [ 'SearchResourceTagsResponse$Tags' => 'A list of tags used in the Amazon Connect instance.
', ], ], 'TaskActionDefinition' => [ 'base' => 'Information about the task action.
', 'refs' => [ 'RuleAction$TaskAction' => 'Information about the task action. This field is required if TriggerEventSource
is one of the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
', ], ], 'TaskNameExpression' => [ 'base' => NULL, 'refs' => [ 'TaskActionDefinition$Name' => 'The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
', ], ], 'TaskTemplateArn' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateResponse$Arn' => 'The Amazon Resource Name (ARN) for the task template resource.
', 'GetTaskTemplateResponse$Arn' => 'The Amazon Resource Name (ARN).
', 'TaskTemplateMetadata$Arn' => 'The Amazon Resource Name (ARN) of the task template.
', 'UpdateTaskTemplateResponse$Arn' => 'The Amazon Resource Name (ARN) for the task template resource.
', ], ], 'TaskTemplateConstraints' => [ 'base' => 'Describes constraints that apply to the template fields.
', 'refs' => [ 'CreateTaskTemplateRequest$Constraints' => 'Constraints that are applicable to the fields listed.
', 'GetTaskTemplateResponse$Constraints' => 'Constraints that are applicable to the fields listed.
', 'UpdateTaskTemplateRequest$Constraints' => 'Constraints that are applicable to the fields listed.
', 'UpdateTaskTemplateResponse$Constraints' => 'Constraints that are applicable to the fields listed.
', ], ], 'TaskTemplateDefaultFieldValue' => [ 'base' => 'Describes a default field and its corresponding value.
', 'refs' => [ 'TaskTemplateDefaultFieldValueList$member' => NULL, ], ], 'TaskTemplateDefaultFieldValueList' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateDefaults$DefaultFieldValues' => 'Default value for the field.
', ], ], 'TaskTemplateDefaults' => [ 'base' => 'Describes default values for fields on a template.
', 'refs' => [ 'CreateTaskTemplateRequest$Defaults' => 'The default values for fields when a task is created by referencing this template.
', 'GetTaskTemplateResponse$Defaults' => 'The default values for fields when a task is created by referencing this template.
', 'UpdateTaskTemplateRequest$Defaults' => 'The default values for fields when a task is created by referencing this template.
', 'UpdateTaskTemplateResponse$Defaults' => 'The default values for fields when a task is created by referencing this template.
', ], ], 'TaskTemplateDescription' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateRequest$Description' => 'The description of the task template.
', 'GetTaskTemplateResponse$Description' => 'The description of the task template.
', 'TaskTemplateMetadata$Description' => 'The description of the task template.
', 'UpdateTaskTemplateRequest$Description' => 'The description of the task template.
', 'UpdateTaskTemplateResponse$Description' => 'The description of the task template.
', ], ], 'TaskTemplateField' => [ 'base' => 'Describes a single task template field.
', 'refs' => [ 'TaskTemplateFields$member' => NULL, ], ], 'TaskTemplateFieldDescription' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateField$Description' => 'The description of the field.
', ], ], 'TaskTemplateFieldIdentifier' => [ 'base' => 'The identifier of the task template field.
', 'refs' => [ 'InvisibleFieldInfo$Id' => 'Identifier of the invisible field.
', 'ReadOnlyFieldInfo$Id' => 'Identifier of the read-only field.
', 'RequiredFieldInfo$Id' => 'The unique identifier for the field.
', 'TaskTemplateDefaultFieldValue$Id' => 'Identifier of a field.
', 'TaskTemplateField$Id' => 'The unique identifier for the field.
', ], ], 'TaskTemplateFieldName' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateFieldIdentifier$Name' => 'The name of the task template field.
', ], ], 'TaskTemplateFieldType' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateField$Type' => 'Indicates the type of field.
', ], ], 'TaskTemplateFieldValue' => [ 'base' => NULL, 'refs' => [ 'TaskTemplateDefaultFieldValue$DefaultValue' => 'Default value for the field.
', ], ], 'TaskTemplateFields' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateRequest$Fields' => 'Fields that are part of the template.
', 'GetTaskTemplateResponse$Fields' => 'Fields that are part of the template.
', 'UpdateTaskTemplateRequest$Fields' => 'Fields that are part of the template.
', 'UpdateTaskTemplateResponse$Fields' => 'Fields that are part of the template.
', ], ], 'TaskTemplateId' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateResponse$Id' => 'The identifier of the task template resource.
', 'DeleteTaskTemplateRequest$TaskTemplateId' => 'A unique identifier for the task template.
', 'GetTaskTemplateRequest$TaskTemplateId' => 'A unique identifier for the task template.
', 'GetTaskTemplateResponse$Id' => 'A unique identifier for the task template.
', 'StartTaskContactRequest$TaskTemplateId' => 'A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
', 'TaskTemplateMetadata$Id' => 'A unique identifier for the task template.
', 'UpdateTaskTemplateRequest$TaskTemplateId' => 'A unique identifier for the task template.
', 'UpdateTaskTemplateResponse$Id' => 'The identifier of the task template resource.
', ], ], 'TaskTemplateList' => [ 'base' => NULL, 'refs' => [ 'ListTaskTemplatesResponse$TaskTemplates' => 'Provides details about a list of task templates belonging to an instance.
', ], ], 'TaskTemplateMetadata' => [ 'base' => 'Contains summary information about the task template.
', 'refs' => [ 'TaskTemplateList$member' => NULL, ], ], 'TaskTemplateName' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateRequest$Name' => 'The name of the task template.
', 'GetTaskTemplateResponse$Name' => 'The name of the task template.
', 'ListTaskTemplatesRequest$Name' => 'The name of the task template.
', 'TaskTemplateMetadata$Name' => 'The name of the task template.
', 'UpdateTaskTemplateRequest$Name' => 'The name of the task template.
', 'UpdateTaskTemplateResponse$Name' => 'The name of the task template.
', ], ], 'TaskTemplateSingleSelectOption' => [ 'base' => NULL, 'refs' => [ 'SingleSelectOptions$member' => NULL, ], ], 'TaskTemplateStatus' => [ 'base' => NULL, 'refs' => [ 'CreateTaskTemplateRequest$Status' => 'Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
Marks a template as ACTIVE
or INACTIVE
for a task to refer to it. Tasks can only be created from ACTIVE
templates. If a template is marked as INACTIVE
, then a task that refers to this template cannot be created.
The distribution of traffic between the instance and its replicas.
', 'refs' => [ 'GetTrafficDistributionResponse$TelephonyConfig' => 'The distribution of traffic between the instance and its replicas.
', 'UpdateTrafficDistributionRequest$TelephonyConfig' => 'The distribution of traffic between the instance and its replica(s).
', ], ], 'TemplateId' => [ 'base' => NULL, 'refs' => [ 'CreateCaseActionDefinition$TemplateId' => 'A unique identifier of a template.
', ], ], 'Threshold' => [ 'base' => 'Contains information about the threshold for service level metrics.
', 'refs' => [ 'HistoricalMetric$Threshold' => 'The threshold for the metric, used with service level metrics.
', ], ], 'ThresholdCollections' => [ 'base' => NULL, 'refs' => [ 'MetricV2$Threshold' => 'Contains information about the threshold for service level metrics.
', ], ], 'ThresholdV2' => [ 'base' => 'Contains information about the threshold for service level metrics.
', 'refs' => [ 'ThresholdCollections$member' => NULL, ], ], 'ThresholdValue' => [ 'base' => NULL, 'refs' => [ 'Threshold$ThresholdValue' => 'The threshold value to compare.
', 'ThresholdV2$ThresholdValue' => 'The threshold value to compare.
', ], ], 'ThrottlingException' => [ 'base' => 'The throttling limit has been exceeded.
', 'refs' => [], ], 'TimeZone' => [ 'base' => NULL, 'refs' => [ 'CreateHoursOfOperationRequest$TimeZone' => 'The time zone of the hours of operation.
', 'HoursOfOperation$TimeZone' => 'The time zone for the hours of operation.
', 'UpdateHoursOfOperationRequest$TimeZone' => 'The time zone of the hours of operation.
', ], ], 'TimerEligibleParticipantRoles' => [ 'base' => NULL, 'refs' => [ 'ParticipantTimerConfiguration$ParticipantRole' => 'The role of the participant in the chat conversation.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AgentContactReference$StateStartTimestamp' => 'The epoch timestamp when the contact state started.
', 'AgentContactReference$ConnectedToAgentTimestamp' => 'The time at which the contact was connected to an agent.
', 'AgentStatus$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'AgentStatusReference$StatusStartTimestamp' => 'The start timestamp of the agent\'s status.
', 'AgentStatusSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'Evaluation$CreatedTime' => 'The timestamp for when the evaluation was created.
', 'Evaluation$LastModifiedTime' => 'The timestamp for when the evaluation was last updated.
', 'EvaluationForm$CreatedTime' => 'The timestamp for when the evaluation form was created.
', 'EvaluationForm$LastModifiedTime' => 'The timestamp for when the evaluation form was last updated.
', 'EvaluationFormSummary$CreatedTime' => 'The timestamp for when the evaluation form was created.
', 'EvaluationFormSummary$LastModifiedTime' => 'The timestamp for when the evaluation form was last updated.
', 'EvaluationFormSummary$LastActivatedTime' => 'The timestamp for when the evaluation form was last activated.
', 'EvaluationFormVersionSummary$CreatedTime' => 'The timestamp for when the evaluation form was created.
', 'EvaluationFormVersionSummary$LastModifiedTime' => 'The timestamp for when the evaluation form was last updated.
', 'EvaluationSummary$CreatedTime' => 'The timestamp for when the evaluation was created.
', 'EvaluationSummary$LastModifiedTime' => 'The timestamp for when the evaluation was last updated.
', 'GetMetricDataV2Request$StartTime' => 'The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be before the end time timestamp. The start and end time depends on the IntervalPeriod
selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be later than the start time timestamp. It cannot be later than the current timestamp.
', 'GetPromptFileResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HierarchyGroup$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HierarchyGroupSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HierarchyLevel$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HoursOfOperation$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'HoursOfOperationSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'Instance$CreatedTime' => 'When the instance was created.
', 'InstanceSummary$CreatedTime' => 'When the instance was created.
', 'ListQueueQuickConnectsResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'ListRoutingProfileQueuesResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'ListSecurityProfileApplicationsResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'ListSecurityProfilePermissionsResponse$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'ListUserProficienciesResponse$LastModifiedTime' => 'The last time that the user\'s proficiencies are were modified.
', 'MetricInterval$StartTime' => 'The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected.
', 'MetricInterval$EndTime' => 'The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If IntervalPeriod
is selected THIRTY_MIN
, StartTime
and EndTime
in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each StartTime
and EndTime
differing by 30 minutes.
Last modified time.
', 'PredefinedAttributeSummary$LastModifiedTime' => 'Last modified time.
', 'Prompt$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'PromptSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'Queue$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'QueueSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'QuickConnect$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'QuickConnectSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'RoutingProfile$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'RoutingProfileSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'Rule$CreatedTime' => 'The timestamp for when the rule was created.
', 'Rule$LastUpdatedTime' => 'The timestamp for the when the rule was last updated.
', 'RuleSummary$CreatedTime' => 'The timestamp for when the rule was created.
', 'RuleSummary$LastUpdatedTime' => 'The timestamp for when the rule was last updated.
', 'SearchContactsTimeRange$StartTime' => 'The start time of the time range.
', 'SearchContactsTimeRange$EndTime' => 'The end time of the time range.
', 'SecurityProfile$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'SecurityProfileSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'StartTaskContactRequest$ScheduledTime' => 'The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
', 'UpdateContactScheduleRequest$ScheduledTime' => 'The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
', 'User$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'UserSummary$LastModifiedTime' => 'The timestamp when this resource was last modified.
', 'View$CreatedTime' => 'The timestamp of when the view was created.
', 'View$LastModifiedTime' => 'Latest timestamp of the UpdateViewContent
or CreateViewVersion
operations.
Displayed when rate-related API limits are exceeded.
', 'refs' => [], ], 'TotalCount' => [ 'base' => NULL, 'refs' => [ 'SearchContactsResponse$TotalCount' => 'The total number of contacts which matched your search query.
', ], ], 'TotalPauseCount' => [ 'base' => NULL, 'refs' => [ 'Contact$TotalPauseCount' => 'Total pause count for a contact.
', ], ], 'TotalPauseDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'Contact$TotalPauseDurationInSeconds' => 'Total pause duration for a contact in seconds.
', ], ], 'TrafficDistributionGroup' => [ 'base' => 'Information about a traffic distribution group.
', 'refs' => [ 'DescribeTrafficDistributionGroupResponse$TrafficDistributionGroup' => 'Information about the traffic distribution group.
', ], ], 'TrafficDistributionGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupResponse$Arn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', 'GetTrafficDistributionResponse$Arn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', 'TrafficDistributionGroup$Arn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', 'TrafficDistributionGroupSummary$Arn' => 'The Amazon Resource Name (ARN) of the traffic distribution group.
', ], ], 'TrafficDistributionGroupId' => [ 'base' => NULL, 'refs' => [ 'CreateTrafficDistributionGroupResponse$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'GetTrafficDistributionResponse$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'TrafficDistributionGroup$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'TrafficDistributionGroupSummary$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', ], ], 'TrafficDistributionGroupIdOrArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTrafficDistributionGroupUserRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'DeleteTrafficDistributionGroupRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'DescribeTrafficDistributionGroupRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'DisassociateTrafficDistributionGroupUserRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'GetTrafficDistributionRequest$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'ListTrafficDistributionGroupUsersRequest$TrafficDistributionGroupId' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', 'UpdateTrafficDistributionRequest$Id' => 'The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
', ], ], 'TrafficDistributionGroupStatus' => [ 'base' => NULL, 'refs' => [ 'TrafficDistributionGroup$Status' => 'The status of the traffic distribution group.
CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistribution operation is still in progress and has not yet completed.
The status of the traffic distribution group.
CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
Information about traffic distribution groups.
', 'refs' => [ 'TrafficDistributionGroupSummaryList$member' => NULL, ], ], 'TrafficDistributionGroupSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListTrafficDistributionGroupsResponse$TrafficDistributionGroupSummaryList' => 'A list of traffic distribution groups.
', ], ], 'TrafficDistributionGroupUserSummary' => [ 'base' => 'Summary information about a traffic distribution group user.
', 'refs' => [ 'TrafficDistributionGroupUserSummaryList$member' => NULL, ], ], 'TrafficDistributionGroupUserSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListTrafficDistributionGroupUsersResponse$TrafficDistributionGroupUserSummaryList' => 'A list of traffic distribution group users.
', ], ], 'TrafficType' => [ 'base' => NULL, 'refs' => [ 'StartOutboundVoiceContactRequest$TrafficType' => 'Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL
. Use CAMPAIGN
if EnableAnswerMachineDetection
is set to true
. For all other cases, use GENERAL
.
A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.
', 'refs' => [ 'ContactAnalysis$Transcript' => 'Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
', ], ], 'TranscriptCriteria' => [ 'base' => 'A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
', 'refs' => [ 'TranscriptCriteriaList$member' => NULL, ], ], 'TranscriptCriteriaList' => [ 'base' => NULL, 'refs' => [ 'Transcript$Criteria' => 'The list of search criteria based on Contact Lens conversational analytics transcript.
', ], ], 'TransferContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'TransferContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'CreateIntegrationAssociationRequest$SourceApplicationUrl' => 'The URL for the external application. This field is only required for the EVENT integration type.
', 'IntegrationAssociationSummary$SourceApplicationUrl' => 'The URL for the external application.
', 'MediaPlacement$AudioHostUrl' => 'The audio host URL.
', 'MediaPlacement$AudioFallbackUrl' => 'The audio fallback URL.
', 'MediaPlacement$SignalingUrl' => 'The signaling URL.
', 'MediaPlacement$TurnControlUrl' => 'The turn control URL.
', 'MediaPlacement$EventIngestionUrl' => 'The event ingestion URL to which you send client meeting events.
', ], ], 'URLExpiryInSeconds' => [ 'base' => NULL, 'refs' => [ 'GetAttachedFileRequest$UrlExpiryInSeconds' => 'Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
', 'StartAttachedFileUploadRequest$UrlExpiryInSeconds' => 'Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
', ], ], 'Unit' => [ 'base' => NULL, 'refs' => [ 'CurrentMetric$Unit' => 'The unit for the metric.
', 'HistoricalMetric$Unit' => 'The unit for the metric.
', ], ], 'UntagContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAgentStatusDescription' => [ 'base' => NULL, 'refs' => [ 'UpdateAgentStatusRequest$Description' => 'The description of the agent status.
', ], ], 'UpdateAgentStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCaseActionDefinition' => [ 'base' => 'The UpdateCase
action definition.
Information about the update case action.
Supported only for TriggerEventSource
values: OnCaseCreate
| OnCaseUpdate
.
The description of the hours of operation.
', ], ], 'UpdateHoursOfOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceStorageConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateParticipantRoleConfigChannelInfo' => [ 'base' => 'Configuration information for the chat participant role.
', 'refs' => [ 'UpdateParticipantRoleConfigRequest$ChannelConfiguration' => 'The Amazon Connect channel you want to configure.
', ], ], 'UpdateParticipantRoleConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateParticipantRoleConfigResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePhoneNumberResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePredefinedAttributeRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePromptRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePromptResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueHoursOfOperationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueMaxContactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueNameRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueOutboundCallerConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQueueStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQuickConnectConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateQuickConnectDescription' => [ 'base' => NULL, 'refs' => [ 'UpdateQuickConnectNameRequest$Description' => 'The description of the quick connect.
', ], ], 'UpdateQuickConnectNameRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileAgentAvailabilityTimerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileConcurrencyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileDefaultOutboundQueueRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileNameRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRoutingProfileQueuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSecurityProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskTemplateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTaskTemplateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrafficDistributionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrafficDistributionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserHierarchyGroupNameRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserHierarchyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserHierarchyStructureRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserIdentityInfoRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserPhoneConfigRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserProficienciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRoutingProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserSecurityProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateViewContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateViewContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateViewMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateViewMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'UploadUrlMetadata' => [ 'base' => 'Fields required when uploading an attached file.
', 'refs' => [ 'StartAttachedFileUploadResponse$UploadUrlMetadata' => 'Information to be used while uploading the attached file.
', ], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'GetFederationTokenResponse$SignInUrl' => 'The URL to sign into the user\'s instance.
', 'Instance$InstanceAccessUrl' => 'This URL allows contact center users to access the Amazon Connect admin website.
', 'InstanceSummary$InstanceAccessUrl' => 'This URL allows contact center users to access the Amazon Connect admin website.
', ], ], 'UrlMetadataSignedHeaders' => [ 'base' => NULL, 'refs' => [ 'UploadUrlMetadata$HeadersToInclude' => 'A map of headers that should be provided when uploading the attached file.
', ], ], 'UrlMetadataSignedHeadersKey' => [ 'base' => NULL, 'refs' => [ 'UrlMetadataSignedHeaders$key' => NULL, ], ], 'UrlMetadataSignedHeadersValue' => [ 'base' => NULL, 'refs' => [ 'UrlMetadataSignedHeaders$value' => NULL, ], ], 'UrlReference' => [ 'base' => 'The URL reference.
', 'refs' => [ 'ReferenceSummary$Url' => 'Information about the reference when the referenceType
is URL
. Otherwise, null.
Contains the use case.
', 'refs' => [ 'UseCaseSummaryList$member' => NULL, ], ], 'UseCaseId' => [ 'base' => NULL, 'refs' => [ 'CreateUseCaseResponse$UseCaseId' => 'The identifier of the use case.
', 'DeleteUseCaseRequest$UseCaseId' => 'The identifier for the use case.
', 'UseCase$UseCaseId' => 'The identifier for the use case.
', ], ], 'UseCaseSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListUseCasesResponse$UseCaseSummaryList' => 'The use cases.
', ], ], 'UseCaseType' => [ 'base' => NULL, 'refs' => [ 'CreateUseCaseRequest$UseCaseType' => 'The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
', 'UseCase$UseCaseType' => 'The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
', ], ], 'User' => [ 'base' => 'Contains information about a user account for an Amazon Connect instance.
', 'refs' => [ 'DescribeUserResponse$User' => 'Information about the user account and configuration settings.
', ], ], 'UserData' => [ 'base' => 'Data for a user.
', 'refs' => [ 'UserDataList$member' => NULL, ], ], 'UserDataFilters' => [ 'base' => 'A filter for the user data.
', 'refs' => [ 'GetCurrentUserDataRequest$Filters' => 'The filters to apply to returned user data. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1
The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
Currently tagging is only supported on the resources that are passed in the filter.
', ], ], 'UserDataHierarchyGroups' => [ 'base' => NULL, 'refs' => [ 'UserDataFilters$UserHierarchyGroups' => 'A UserHierarchyGroup ID or ARN.
', ], ], 'UserDataList' => [ 'base' => NULL, 'refs' => [ 'GetCurrentUserDataResponse$UserDataList' => 'A list of the user data that is returned.
', ], ], 'UserId' => [ 'base' => NULL, 'refs' => [ 'AgentsMinOneMaxHundred$member' => NULL, 'AssociateTrafficDistributionGroupUserRequest$UserId' => 'The identifier of the user account. This can be the ID or the ARN of the user.
', 'AssociateUserProficienciesRequest$UserId' => 'The identifier of the user account.
', 'CreateUserResponse$UserId' => 'The identifier of the user account.
', 'DeleteUserRequest$UserId' => 'The identifier of the user.
', 'DescribeUserRequest$UserId' => 'The identifier of the user account.
', 'DisassociateTrafficDistributionGroupUserRequest$UserId' => 'The identifier for the user. This can be the ID or the ARN of the user.
', 'DisassociateUserProficienciesRequest$UserId' => 'The identifier of the user account.
', 'DismissUserContactRequest$UserId' => 'The identifier of the user account.
', 'ListUserProficienciesRequest$UserId' => 'The identifier of the user account.
', 'PutUserStatusRequest$UserId' => 'The identifier of the user.
', 'TrafficDistributionGroupUserSummary$UserId' => 'The identifier for the user. This can be the ID or the ARN of the user.
', 'UpdateUserHierarchyRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserIdentityInfoRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserPhoneConfigRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserProficienciesRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserRoutingProfileRequest$UserId' => 'The identifier of the user account.
', 'UpdateUserSecurityProfilesRequest$UserId' => 'The identifier of the user account.
', 'User$Id' => 'The identifier of the user account.
', 'UserIdList$member' => NULL, 'UserQuickConnectConfig$UserId' => 'The identifier of the user.
', 'UserReference$Id' => 'The unique identifier for the user.
', 'UserSearchSummary$Id' => 'The identifier of the user\'s summary.
', 'UserSummary$Id' => 'The identifier of the user account.
', ], ], 'UserIdList' => [ 'base' => NULL, 'refs' => [ 'NotificationRecipientType$UserIds' => 'A list of user IDs.
', ], ], 'UserIdentityInfo' => [ 'base' => 'Contains information about the identity of a user.
For Amazon Connect instances that are created with the EXISTING_DIRECTORY
identity management type, FirstName
, LastName
, and Email
cannot be updated from within Amazon Connect because they are managed by the directory.
The information about the identity of the user.
', 'UpdateUserIdentityInfoRequest$IdentityInfo' => 'The identity information for the user.
', 'User$IdentityInfo' => 'Information about the user identity.
', ], ], 'UserIdentityInfoLite' => [ 'base' => 'The user\'s first name and last name.
', 'refs' => [ 'UserSearchSummary$IdentityInfo' => 'The user\'s first name and last name.
', ], ], 'UserNotFoundException' => [ 'base' => 'No user with the specified credentials was found in the Amazon Connect instance.
', 'refs' => [], ], 'UserPhoneConfig' => [ 'base' => 'Contains information about the phone configuration settings for a user.
', 'refs' => [ 'CreateUserRequest$PhoneConfig' => 'The phone settings for the user.
', 'UpdateUserPhoneConfigRequest$PhoneConfig' => 'Information about phone configuration settings for the user.
', 'User$PhoneConfig' => 'Information about the phone configuration for the user.
', 'UserSearchSummary$PhoneConfig' => NULL, ], ], 'UserProficiency' => [ 'base' => 'Information about proficiency of a user.
', 'refs' => [ 'UserProficiencyList$member' => NULL, ], ], 'UserProficiencyDisassociate' => [ 'base' => 'Information about proficiency to be disassociated from the user.
', 'refs' => [ 'UserProficiencyDisassociateList$member' => NULL, ], ], 'UserProficiencyDisassociateList' => [ 'base' => NULL, 'refs' => [ 'DisassociateUserProficienciesRequest$UserProficiencies' => 'The proficiencies to disassociate from the user.
', ], ], 'UserProficiencyList' => [ 'base' => NULL, 'refs' => [ 'AssociateUserProficienciesRequest$UserProficiencies' => 'The proficiencies to associate with the user.
', 'ListUserProficienciesResponse$UserProficiencyList' => 'Information about the user proficiencies.
', 'UpdateUserProficienciesRequest$UserProficiencies' => 'The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.
', ], ], 'UserQuickConnectConfig' => [ 'base' => 'Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
', 'refs' => [ 'QuickConnectConfig$UserConfig' => 'The user configuration. This is required only if QuickConnectType is USER.
', ], ], 'UserReference' => [ 'base' => 'Information about the user.
', 'refs' => [ 'UserData$User' => 'Information about the user for the data that is returned. It contains the resourceId
and ARN of the user.
A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return users.
The name
and description
fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
Filters to be applied to search results.
', 'refs' => [ 'SearchUsersRequest$SearchFilter' => 'Filters to be applied to search results.
', ], ], 'UserSearchSummary' => [ 'base' => 'Information about the returned users.
', 'refs' => [ 'UserSearchSummaryList$member' => NULL, ], ], 'UserSearchSummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchUsersResponse$Users' => 'Information about the users.
', ], ], 'UserSummary' => [ 'base' => 'Contains summary information about a user.
', 'refs' => [ 'UserSummaryList$member' => NULL, ], ], 'UserSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$UserSummaryList' => 'Information about the users.
', ], ], 'UserTagMap' => [ 'base' => NULL, 'refs' => [ 'NotificationRecipientType$UserTags' => 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.
', ], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'CurrentMetricData$Value' => 'The value of the metric.
', 'HistoricalMetricData$Value' => 'The value of the metric.
', 'MetricDataV2$Value' => 'The corresponding value of the metric returned in the response.
', ], ], 'VersionNumber' => [ 'base' => NULL, 'refs' => [ 'ActivateEvaluationFormRequest$EvaluationFormVersion' => 'The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.
', 'ActivateEvaluationFormResponse$EvaluationFormVersion' => 'A version of the evaluation form.
', 'DeactivateEvaluationFormRequest$EvaluationFormVersion' => 'A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.
', 'DeactivateEvaluationFormResponse$EvaluationFormVersion' => 'The version of the deactivated evaluation form resource.
', 'DeleteEvaluationFormRequest$EvaluationFormVersion' => 'The unique identifier for the evaluation form.
', 'DescribeEvaluationFormRequest$EvaluationFormVersion' => 'A version of the evaluation form.
', 'EvaluationForm$EvaluationFormVersion' => 'A version of the evaluation form.
', 'EvaluationFormContent$EvaluationFormVersion' => 'A version of the evaluation form.
', 'EvaluationFormSummary$LatestVersion' => 'The version number of the latest evaluation form version.
', 'EvaluationFormSummary$ActiveVersion' => 'The version of the active evaluation form version.
', 'EvaluationFormVersionSummary$EvaluationFormVersion' => 'A version of the evaluation form.
', 'UpdateEvaluationFormRequest$EvaluationFormVersion' => 'A version of the evaluation form to update.
', 'UpdateEvaluationFormResponse$EvaluationFormVersion' => 'The version of the updated evaluation form resource.
', ], ], 'VideoCapability' => [ 'base' => NULL, 'refs' => [ 'ParticipantCapabilities$Video' => 'The configuration having the video sharing capabilities for participants over the call.
', ], ], 'View' => [ 'base' => 'A view resource object. Contains metadata and content necessary to render the view.
', 'refs' => [ 'CreateViewResponse$View' => 'A view resource object. Contains metadata and content necessary to render the view.
', 'CreateViewVersionResponse$View' => 'All view data is contained within the View object.
', 'DescribeViewResponse$View' => 'All view data is contained within the View object.
', 'UpdateViewContentResponse$View' => 'A view resource object. Contains metadata and content necessary to render the view.
', ], ], 'ViewAction' => [ 'base' => NULL, 'refs' => [ 'ViewActions$member' => NULL, ], ], 'ViewActions' => [ 'base' => NULL, 'refs' => [ 'ViewContent$Actions' => 'A list of possible actions from the view.
', 'ViewInputContent$Actions' => 'A list of possible actions from the view.
', ], ], 'ViewContent' => [ 'base' => 'View content containing all content necessary to render a view except for runtime input data.
', 'refs' => [ 'View$Content' => 'View content containing all content necessary to render a view except for runtime input data.
', ], ], 'ViewContentSha256' => [ 'base' => NULL, 'refs' => [ 'CreateViewVersionRequest$ViewContentSha256' => 'Indicates the checksum value of the latest published view content.
', 'View$ViewContentSha256' => 'Indicates the checksum value of the latest published view content.
', ], ], 'ViewDescription' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$Description' => 'The description of the view.
', 'CreateViewVersionRequest$VersionDescription' => 'The description for the version being published.
', 'UpdateViewMetadataRequest$Description' => 'The description of the view.
', 'View$Description' => 'The description of the view.
', 'View$VersionDescription' => 'The description of the version.
', 'ViewSummary$Description' => 'The description of the view.
', 'ViewVersionSummary$Description' => 'The description of the view version.
', 'ViewVersionSummary$VersionDescription' => 'The description of the view version.
', ], ], 'ViewId' => [ 'base' => NULL, 'refs' => [ 'CreateViewVersionRequest$ViewId' => 'The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view. Both ViewArn
and ViewId
can be used.
The ViewId of the view. This must be an ARN for Amazon Web Services managed views.
', 'ListViewVersionsRequest$ViewId' => 'The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view. Both ViewArn
and ViewId
can be used.
The identifier of the view.
', 'ViewSummary$Id' => 'The identifier of the view.
', 'ViewVersionSummary$Id' => 'The identifier of the view version.
', ], ], 'ViewInputContent' => [ 'base' => 'View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
', 'refs' => [ 'CreateViewRequest$Content' => 'View content containing all content necessary to render a view except for runtime input data.
The total uncompressed content has a maximum file size of 400kB.
', 'UpdateViewContentRequest$Content' => 'View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
The total uncompressed content has a maximum file size of 400kB.
', ], ], 'ViewInputSchema' => [ 'base' => NULL, 'refs' => [ 'ViewContent$InputSchema' => 'The data schema matching data that the view template must be provided to render.
', ], ], 'ViewName' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$Name' => 'The name of the view.
', 'UpdateViewMetadataRequest$Name' => 'The name of the view.
', 'View$Name' => 'The name of the view.
', 'ViewSummary$Name' => 'The name of the view.
', 'ViewVersionSummary$Name' => 'The name of the view version.
', ], ], 'ViewStatus' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$Status' => 'Indicates the view status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content.
Indicates the view status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content.
Indicates the view status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content.
Indicates the view status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content.
A summary of a view\'s metadata.
', 'refs' => [ 'ViewsSummaryList$member' => NULL, ], ], 'ViewTemplate' => [ 'base' => NULL, 'refs' => [ 'ViewContent$Template' => 'The view template representing the structure of the view.
', 'ViewInputContent$Template' => 'The view template representing the structure of the view.
', ], ], 'ViewType' => [ 'base' => NULL, 'refs' => [ 'ListViewsRequest$Type' => 'The type of the view.
', 'View$Type' => 'The type of the view - CUSTOMER_MANAGED
.
The type of the view.
', 'ViewVersionSummary$Type' => 'The type of the view version.
', ], ], 'ViewVersion' => [ 'base' => NULL, 'refs' => [ 'DeleteViewVersionRequest$ViewVersion' => 'The version number of the view.
', 'View$Version' => 'Current version of the view.
', 'ViewVersionSummary$Version' => 'The sequentially incremented version of the view version.
', ], ], 'ViewVersionSummary' => [ 'base' => 'A summary of a view version\'s metadata.
', 'refs' => [ 'ViewVersionSummaryList$member' => NULL, ], ], 'ViewVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListViewVersionsResponse$ViewVersionSummaryList' => 'A list of view version summaries.
', ], ], 'ViewsClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$ClientToken' => 'A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.
', ], ], 'ViewsInstanceId' => [ 'base' => NULL, 'refs' => [ 'CreateViewRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'CreateViewVersionRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'DeleteViewRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'DeleteViewVersionRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'DescribeViewRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'ListViewVersionsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'ListViewsRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'UpdateViewContentRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', 'UpdateViewMetadataRequest$InstanceId' => 'The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
', ], ], 'ViewsNextToken' => [ 'base' => NULL, 'refs' => [ 'ListViewVersionsRequest$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.
', 'ListViewVersionsResponse$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.
', 'ListViewsRequest$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.
', 'ListViewsResponse$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.
', ], ], 'ViewsSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListViewsResponse$ViewsSummaryList' => 'A list of view summaries.
', ], ], 'Vocabulary' => [ 'base' => 'Contains information about a custom vocabulary.
', 'refs' => [ 'DescribeVocabularyResponse$Vocabulary' => 'A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.
', ], ], 'VocabularyContent' => [ 'base' => NULL, 'refs' => [ 'CreateVocabularyRequest$Content' => 'The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase
, IPA
, SoundsLike
, and DisplayAs
fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase
, IPA
, SoundsLike
, and DisplayAs
fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
The reason why the custom vocabulary was not created.
', 'VocabularySummary$FailureReason' => 'The reason why the custom vocabulary was not created.
', ], ], 'VocabularyId' => [ 'base' => NULL, 'refs' => [ 'AssociateDefaultVocabularyRequest$VocabularyId' => 'The identifier of the custom vocabulary. If this is empty, the default is set to none.
', 'CreateVocabularyResponse$VocabularyId' => 'The identifier of the custom vocabulary.
', 'DefaultVocabulary$VocabularyId' => 'The identifier of the custom vocabulary.
', 'DeleteVocabularyRequest$VocabularyId' => 'The identifier of the custom vocabulary.
', 'DeleteVocabularyResponse$VocabularyId' => 'The identifier of the custom vocabulary.
', 'DescribeVocabularyRequest$VocabularyId' => 'The identifier of the custom vocabulary.
', 'Vocabulary$Id' => 'The identifier of the custom vocabulary.
', 'VocabularySummary$Id' => 'The identifier of the custom vocabulary.
', ], ], 'VocabularyLanguageCode' => [ 'base' => NULL, 'refs' => [ 'AssociateDefaultVocabularyRequest$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'CreateVocabularyRequest$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'DefaultVocabulary$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'ListDefaultVocabulariesRequest$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'SearchVocabulariesRequest$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'Vocabulary$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', 'VocabularySummary$LanguageCode' => 'The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
', ], ], 'VocabularyLastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'Vocabulary$LastModifiedTime' => 'The timestamp when the custom vocabulary was last modified.
', 'VocabularySummary$LastModifiedTime' => 'The timestamp when the custom vocabulary was last modified.
', ], ], 'VocabularyName' => [ 'base' => NULL, 'refs' => [ 'CreateVocabularyRequest$VocabularyName' => 'A unique name of the custom vocabulary.
', 'DefaultVocabulary$VocabularyName' => 'A unique name of the custom vocabulary.
', 'SearchVocabulariesRequest$NameStartsWith' => 'The starting pattern of the name of the vocabulary.
', 'Vocabulary$Name' => 'A unique name of the custom vocabulary.
', 'VocabularySummary$Name' => 'A unique name of the custom vocabulary.
', ], ], 'VocabularyNextToken' => [ 'base' => NULL, 'refs' => [ 'ListDefaultVocabulariesRequest$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.
', 'ListDefaultVocabulariesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchVocabulariesRequest$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.
', 'SearchVocabulariesResponse$NextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'VocabularyState' => [ 'base' => NULL, 'refs' => [ 'CreateVocabularyResponse$State' => 'The current state of the custom vocabulary.
', 'DeleteVocabularyResponse$State' => 'The current state of the custom vocabulary.
', 'SearchVocabulariesRequest$State' => 'The current state of the custom vocabulary.
', 'Vocabulary$State' => 'The current state of the custom vocabulary.
', 'VocabularySummary$State' => 'The current state of the custom vocabulary.
', ], ], 'VocabularySummary' => [ 'base' => 'Contains summary information about the custom vocabulary.
', 'refs' => [ 'VocabularySummaryList$member' => NULL, ], ], 'VocabularySummaryList' => [ 'base' => NULL, 'refs' => [ 'SearchVocabulariesResponse$VocabularySummaryList' => 'The list of the available custom vocabularies.
', ], ], 'VoiceRecordingConfiguration' => [ 'base' => 'Contains information about the recording configuration settings.
', 'refs' => [ 'StartContactRecordingRequest$VoiceRecordingConfiguration' => 'The person being recorded.
', ], ], 'VoiceRecordingTrack' => [ 'base' => NULL, 'refs' => [ 'VoiceRecordingConfiguration$VoiceRecordingTrack' => 'Identifies which track is being recorded.
', ], ], 'WisdomInfo' => [ 'base' => 'Information about Amazon Connect Wisdom.
', 'refs' => [ 'Contact$WisdomInfo' => 'Information about Amazon Connect Wisdom.
', ], ], 'resourceArnListMaxLimit100' => [ 'base' => NULL, 'refs' => [ 'BatchGetFlowAssociationRequest$ResourceIds' => 'A list of resource identifiers to retrieve flow associations.
', ], ], 'timestamp' => [ 'base' => NULL, 'refs' => [ 'AgentInfo$ConnectedToAgentTimestamp' => 'The timestamp when the contact was connected to the agent.
', 'Contact$InitiationTimestamp' => 'The date and time this contact was initiated, in UTC time. For INBOUND
, this is when the contact arrived. For OUTBOUND
, this is when the agent began dialing. For CALLBACK
, this is when the callback contact was created. For TRANSFER
and QUEUE_TRANSFER
, this is when the transfer was initiated. For API
, this is when the request arrived. For EXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. For MONITOR
, this is when the supervisor started listening to a contact.
The timestamp when the customer endpoint disconnected from Amazon Connect.
', 'Contact$LastUpdateTimestamp' => 'The timestamp when contact was last updated.
', 'Contact$LastPausedTimestamp' => 'The timestamp when the contact was last paused.
', 'Contact$LastResumedTimestamp' => 'The timestamp when the contact was last resumed.
', 'Contact$ScheduledTimestamp' => 'The timestamp, in Unix epoch time format, at which to start running the inbound flow.
', 'Contact$ConnectedToSystemTimestamp' => 'The timestamp when customer endpoint connected to Amazon Connect.
', 'ContactSearchSummary$InitiationTimestamp' => 'The date and time this contact was initiated, in UTC time. For INBOUND
, this is when the contact arrived. For OUTBOUND
, this is when the agent began dialing. For CALLBACK
, this is when the callback contact was created. For TRANSFER
and QUEUE_TRANSFER
, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. For MONITOR
, this is when the supervisor started listening to a contact.
The timestamp when the customer endpoint disconnected from Amazon Connect.
', 'ContactSearchSummary$ScheduledTimestamp' => 'The timestamp, in Unix epoch time format, at which to start running the inbound flow.
', 'ContactSearchSummaryAgentInfo$ConnectedToAgentTimestamp' => 'The timestamp when the contact was connected to the agent.
', 'ContactSearchSummaryQueueInfo$EnqueueTimestamp' => 'The timestamp when the contact was added to the queue.
', 'Credentials$AccessTokenExpiration' => 'A token generated with an expiration time for the session a user is logged in to Amazon Connect.
', 'Credentials$RefreshTokenExpiration' => 'Renews the expiration timer for a generated token.
', 'CustomerVoiceActivity$GreetingStartTimestamp' => 'Timestamp that measures the beginning of the customer greeting from an outbound voice call.
', 'CustomerVoiceActivity$GreetingEndTimestamp' => 'Timestamp that measures the end of the customer greeting from an outbound voice call.
', 'Expiry$ExpiryTimestamp' => 'The timestamp indicating when the routing step expires.
', 'GetCurrentMetricDataResponse$DataSnapshotTime' => 'The time at which the metrics were retrieved and cached for pagination.
', 'GetMetricDataRequest$StartTime' => 'The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
', 'GetMetricDataRequest$EndTime' => 'The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
', 'GetTaskTemplateResponse$LastModifiedTime' => 'The timestamp when the task template was last modified.
', 'GetTaskTemplateResponse$CreatedTime' => 'The timestamp when the task template was created.
', 'QueueInfo$EnqueueTimestamp' => 'The timestamp when the contact was added to the queue.
', 'RoutingCriteria$ActivationTimestamp' => 'The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
', 'SecurityKey$CreationTime' => 'When the security key was created.
', 'TaskTemplateMetadata$LastModifiedTime' => 'The timestamp when the task template was last modified.
', 'TaskTemplateMetadata$CreatedTime' => 'The timestamp when the task template was created.
', 'UpdateTaskTemplateResponse$LastModifiedTime' => 'The timestamp when the task template was last modified.
', 'UpdateTaskTemplateResponse$CreatedTime' => 'The timestamp when the task template was created.
', ], ], ],]; diff --git a/src/data/elasticmapreduce/2009-03-31/api-2.json b/src/data/elasticmapreduce/2009-03-31/api-2.json index 47a4b13527..94e0728927 100644 --- a/src/data/elasticmapreduce/2009-03-31/api-2.json +++ b/src/data/elasticmapreduce/2009-03-31/api-2.json @@ -5,12 +5,14 @@ "endpointPrefix":"elasticmapreduce", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"Amazon EMR", "serviceFullName":"Amazon EMR", "serviceId":"EMR", "signatureVersion":"v4", "targetPrefix":"ElasticMapReduce", - "uid":"elasticmapreduce-2009-03-31" + "uid":"elasticmapreduce-2009-03-31", + "auth":["aws.auth#sigv4"] }, "operations":{ "AddInstanceFleet":{ @@ -1964,7 +1966,8 @@ "BidPriceAsPercentageOfOnDemandPrice":{"shape":"NonNegativeDouble"}, "EbsConfiguration":{"shape":"EbsConfiguration"}, "Configurations":{"shape":"ConfigurationList"}, - "CustomAmiId":{"shape":"XmlStringMaxLen256"} + "CustomAmiId":{"shape":"XmlStringMaxLen256"}, + "Priority":{"shape":"NonNegativeDouble"} } }, "InstanceTypeConfigList":{ @@ -1981,7 +1984,8 @@ "Configurations":{"shape":"ConfigurationList"}, "EbsBlockDevices":{"shape":"EbsBlockDeviceList"}, "EbsOptimized":{"shape":"BooleanObject"}, - "CustomAmiId":{"shape":"XmlStringMaxLen256"} + "CustomAmiId":{"shape":"XmlStringMaxLen256"}, + "Priority":{"shape":"NonNegativeDouble"} } }, "InstanceTypeSpecificationList":{ @@ -2502,7 +2506,10 @@ }, "OnDemandProvisioningAllocationStrategy":{ "type":"string", - "enum":["lowest-price"] + "enum":[ + "lowest-price", + "prioritized" + ] }, "OnDemandProvisioningSpecification":{ "type":"structure", @@ -2953,7 +2960,8 @@ "capacity-optimized", "price-capacity-optimized", "lowest-price", - "diversified" + "diversified", + "capacity-optimized-prioritized" ] }, "SpotProvisioningSpecification":{ diff --git a/src/data/elasticmapreduce/2009-03-31/api-2.json.php b/src/data/elasticmapreduce/2009-03-31/api-2.json.php index 84da6544a2..05ec30de3e 100644 --- a/src/data/elasticmapreduce/2009-03-31/api-2.json.php +++ b/src/data/elasticmapreduce/2009-03-31/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2009-03-31', 'endpointPrefix' => 'elasticmapreduce', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceAbbreviation' => 'Amazon EMR', 'serviceFullName' => 'Amazon EMR', 'serviceId' => 'EMR', 'signatureVersion' => 'v4', 'targetPrefix' => 'ElasticMapReduce', 'uid' => 'elasticmapreduce-2009-03-31', ], 'operations' => [ 'AddInstanceFleet' => [ 'name' => 'AddInstanceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddInstanceFleetInput', ], 'output' => [ 'shape' => 'AddInstanceFleetOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddInstanceGroups' => [ 'name' => 'AddInstanceGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddInstanceGroupsInput', ], 'output' => [ 'shape' => 'AddInstanceGroupsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'AddJobFlowSteps' => [ 'name' => 'AddJobFlowSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddJobFlowStepsInput', ], 'output' => [ 'shape' => 'AddJobFlowStepsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsInput', ], 'output' => [ 'shape' => 'AddTagsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'CancelSteps' => [ 'name' => 'CancelSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CancelStepsInput', ], 'output' => [ 'shape' => 'CancelStepsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'CreateSecurityConfiguration' => [ 'name' => 'CreateSecurityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSecurityConfigurationInput', ], 'output' => [ 'shape' => 'CreateSecurityConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'CreateStudio' => [ 'name' => 'CreateStudio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioInput', ], 'output' => [ 'shape' => 'CreateStudioOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'CreateStudioSessionMapping' => [ 'name' => 'CreateStudioSessionMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioSessionMappingInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteSecurityConfiguration' => [ 'name' => 'DeleteSecurityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSecurityConfigurationInput', ], 'output' => [ 'shape' => 'DeleteSecurityConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteStudio' => [ 'name' => 'DeleteStudio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioInput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteStudioSessionMapping' => [ 'name' => 'DeleteStudioSessionMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioSessionMappingInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeCluster' => [ 'name' => 'DescribeCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterInput', ], 'output' => [ 'shape' => 'DescribeClusterOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeJobFlows' => [ 'name' => 'DescribeJobFlows', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeJobFlowsInput', ], 'output' => [ 'shape' => 'DescribeJobFlowsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], 'deprecated' => true, ], 'DescribeNotebookExecution' => [ 'name' => 'DescribeNotebookExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookExecutionInput', ], 'output' => [ 'shape' => 'DescribeNotebookExecutionOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeReleaseLabel' => [ 'name' => 'DescribeReleaseLabel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReleaseLabelInput', ], 'output' => [ 'shape' => 'DescribeReleaseLabelOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeSecurityConfiguration' => [ 'name' => 'DescribeSecurityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSecurityConfigurationInput', ], 'output' => [ 'shape' => 'DescribeSecurityConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeStep' => [ 'name' => 'DescribeStep', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStepInput', ], 'output' => [ 'shape' => 'DescribeStepOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeStudio' => [ 'name' => 'DescribeStudio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStudioInput', ], 'output' => [ 'shape' => 'DescribeStudioOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'GetAutoTerminationPolicy' => [ 'name' => 'GetAutoTerminationPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAutoTerminationPolicyInput', ], 'output' => [ 'shape' => 'GetAutoTerminationPolicyOutput', ], ], 'GetBlockPublicAccessConfiguration' => [ 'name' => 'GetBlockPublicAccessConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBlockPublicAccessConfigurationInput', ], 'output' => [ 'shape' => 'GetBlockPublicAccessConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'GetClusterSessionCredentials' => [ 'name' => 'GetClusterSessionCredentials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetClusterSessionCredentialsInput', ], 'output' => [ 'shape' => 'GetClusterSessionCredentialsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'GetManagedScalingPolicy' => [ 'name' => 'GetManagedScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetManagedScalingPolicyInput', ], 'output' => [ 'shape' => 'GetManagedScalingPolicyOutput', ], ], 'GetStudioSessionMapping' => [ 'name' => 'GetStudioSessionMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStudioSessionMappingInput', ], 'output' => [ 'shape' => 'GetStudioSessionMappingOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListBootstrapActions' => [ 'name' => 'ListBootstrapActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBootstrapActionsInput', ], 'output' => [ 'shape' => 'ListBootstrapActionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersInput', ], 'output' => [ 'shape' => 'ListClustersOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListInstanceFleets' => [ 'name' => 'ListInstanceFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInstanceFleetsInput', ], 'output' => [ 'shape' => 'ListInstanceFleetsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListInstanceGroups' => [ 'name' => 'ListInstanceGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInstanceGroupsInput', ], 'output' => [ 'shape' => 'ListInstanceGroupsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListInstances' => [ 'name' => 'ListInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInstancesInput', ], 'output' => [ 'shape' => 'ListInstancesOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListNotebookExecutions' => [ 'name' => 'ListNotebookExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookExecutionsInput', ], 'output' => [ 'shape' => 'ListNotebookExecutionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListReleaseLabels' => [ 'name' => 'ListReleaseLabels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListReleaseLabelsInput', ], 'output' => [ 'shape' => 'ListReleaseLabelsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListSecurityConfigurations' => [ 'name' => 'ListSecurityConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSecurityConfigurationsInput', ], 'output' => [ 'shape' => 'ListSecurityConfigurationsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListSteps' => [ 'name' => 'ListSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStepsInput', ], 'output' => [ 'shape' => 'ListStepsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListStudioSessionMappings' => [ 'name' => 'ListStudioSessionMappings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudioSessionMappingsInput', ], 'output' => [ 'shape' => 'ListStudioSessionMappingsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListStudios' => [ 'name' => 'ListStudios', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudiosInput', ], 'output' => [ 'shape' => 'ListStudiosOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListSupportedInstanceTypes' => [ 'name' => 'ListSupportedInstanceTypes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSupportedInstanceTypesInput', ], 'output' => [ 'shape' => 'ListSupportedInstanceTypesOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ModifyCluster' => [ 'name' => 'ModifyCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyClusterInput', ], 'output' => [ 'shape' => 'ModifyClusterOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ModifyInstanceFleet' => [ 'name' => 'ModifyInstanceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyInstanceFleetInput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ModifyInstanceGroups' => [ 'name' => 'ModifyInstanceGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyInstanceGroupsInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'PutAutoScalingPolicy' => [ 'name' => 'PutAutoScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAutoScalingPolicyInput', ], 'output' => [ 'shape' => 'PutAutoScalingPolicyOutput', ], ], 'PutAutoTerminationPolicy' => [ 'name' => 'PutAutoTerminationPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAutoTerminationPolicyInput', ], 'output' => [ 'shape' => 'PutAutoTerminationPolicyOutput', ], ], 'PutBlockPublicAccessConfiguration' => [ 'name' => 'PutBlockPublicAccessConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutBlockPublicAccessConfigurationInput', ], 'output' => [ 'shape' => 'PutBlockPublicAccessConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'PutManagedScalingPolicy' => [ 'name' => 'PutManagedScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutManagedScalingPolicyInput', ], 'output' => [ 'shape' => 'PutManagedScalingPolicyOutput', ], ], 'RemoveAutoScalingPolicy' => [ 'name' => 'RemoveAutoScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveAutoScalingPolicyInput', ], 'output' => [ 'shape' => 'RemoveAutoScalingPolicyOutput', ], ], 'RemoveAutoTerminationPolicy' => [ 'name' => 'RemoveAutoTerminationPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveAutoTerminationPolicyInput', ], 'output' => [ 'shape' => 'RemoveAutoTerminationPolicyOutput', ], ], 'RemoveManagedScalingPolicy' => [ 'name' => 'RemoveManagedScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveManagedScalingPolicyInput', ], 'output' => [ 'shape' => 'RemoveManagedScalingPolicyOutput', ], ], 'RemoveTags' => [ 'name' => 'RemoveTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsInput', ], 'output' => [ 'shape' => 'RemoveTagsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'RunJobFlow' => [ 'name' => 'RunJobFlow', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RunJobFlowInput', ], 'output' => [ 'shape' => 'RunJobFlowOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'SetKeepJobFlowAliveWhenNoSteps' => [ 'name' => 'SetKeepJobFlowAliveWhenNoSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetKeepJobFlowAliveWhenNoStepsInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'SetTerminationProtection' => [ 'name' => 'SetTerminationProtection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetTerminationProtectionInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'SetUnhealthyNodeReplacement' => [ 'name' => 'SetUnhealthyNodeReplacement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUnhealthyNodeReplacementInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'SetVisibleToAllUsers' => [ 'name' => 'SetVisibleToAllUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetVisibleToAllUsersInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'StartNotebookExecution' => [ 'name' => 'StartNotebookExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartNotebookExecutionInput', ], 'output' => [ 'shape' => 'StartNotebookExecutionOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'StopNotebookExecution' => [ 'name' => 'StopNotebookExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopNotebookExecutionInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'TerminateJobFlows' => [ 'name' => 'TerminateJobFlows', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TerminateJobFlowsInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'UpdateStudio' => [ 'name' => 'UpdateStudio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateStudioInput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'UpdateStudioSessionMapping' => [ 'name' => 'UpdateStudioSessionMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateStudioSessionMappingInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], ], 'shapes' => [ 'ActionOnFailure' => [ 'type' => 'string', 'enum' => [ 'TERMINATE_JOB_FLOW', 'TERMINATE_CLUSTER', 'CANCEL_AND_WAIT', 'CONTINUE', ], ], 'AddInstanceFleetInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'InstanceFleet', ], 'members' => [ 'ClusterId' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceFleet' => [ 'shape' => 'InstanceFleetConfig', ], ], ], 'AddInstanceFleetOutput' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceFleetId' => [ 'shape' => 'InstanceFleetId', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], ], ], 'AddInstanceGroupsInput' => [ 'type' => 'structure', 'required' => [ 'InstanceGroups', 'JobFlowId', ], 'members' => [ 'InstanceGroups' => [ 'shape' => 'InstanceGroupConfigList', ], 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'AddInstanceGroupsOutput' => [ 'type' => 'structure', 'members' => [ 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceGroupIds' => [ 'shape' => 'InstanceGroupIdsList', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], ], ], 'AddJobFlowStepsInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowId', 'Steps', ], 'members' => [ 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Steps' => [ 'shape' => 'StepConfigList', ], 'ExecutionRoleArn' => [ 'shape' => 'ArnType', ], ], ], 'AddJobFlowStepsOutput' => [ 'type' => 'structure', 'members' => [ 'StepIds' => [ 'shape' => 'StepIdsList', ], ], ], 'AddTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'Tags', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AddTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'AdjustmentType' => [ 'type' => 'string', 'enum' => [ 'CHANGE_IN_CAPACITY', 'PERCENT_CHANGE_IN_CAPACITY', 'EXACT_CAPACITY', ], ], 'Application' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Version' => [ 'shape' => 'String', ], 'Args' => [ 'shape' => 'StringList', ], 'AdditionalInfo' => [ 'shape' => 'StringMap', ], ], ], 'ApplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Application', ], ], 'ArnType' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'AuthMode' => [ 'type' => 'string', 'enum' => [ 'SSO', 'IAM', ], ], 'AutoScalingPolicy' => [ 'type' => 'structure', 'required' => [ 'Constraints', 'Rules', ], 'members' => [ 'Constraints' => [ 'shape' => 'ScalingConstraints', ], 'Rules' => [ 'shape' => 'ScalingRuleList', ], ], ], 'AutoScalingPolicyDescription' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'AutoScalingPolicyStatus', ], 'Constraints' => [ 'shape' => 'ScalingConstraints', ], 'Rules' => [ 'shape' => 'ScalingRuleList', ], ], ], 'AutoScalingPolicyState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'ATTACHING', 'ATTACHED', 'DETACHING', 'DETACHED', 'FAILED', ], ], 'AutoScalingPolicyStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'AutoScalingPolicyStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'AutoScalingPolicyStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'USER_REQUEST', 'PROVISION_FAILURE', 'CLEANUP_FAILURE', ], ], 'AutoScalingPolicyStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'AutoScalingPolicyState', ], 'StateChangeReason' => [ 'shape' => 'AutoScalingPolicyStateChangeReason', ], ], ], 'AutoTerminationPolicy' => [ 'type' => 'structure', 'members' => [ 'IdleTimeout' => [ 'shape' => 'Long', ], ], ], 'BlockPublicAccessConfiguration' => [ 'type' => 'structure', 'required' => [ 'BlockPublicSecurityGroupRules', ], 'members' => [ 'BlockPublicSecurityGroupRules' => [ 'shape' => 'Boolean', ], 'PermittedPublicSecurityGroupRuleRanges' => [ 'shape' => 'PortRanges', ], ], ], 'BlockPublicAccessConfigurationMetadata' => [ 'type' => 'structure', 'required' => [ 'CreationDateTime', 'CreatedByArn', ], 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'CreatedByArn' => [ 'shape' => 'ArnType', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'BootstrapActionConfig' => [ 'type' => 'structure', 'required' => [ 'Name', 'ScriptBootstrapAction', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'ScriptBootstrapAction' => [ 'shape' => 'ScriptBootstrapActionConfig', ], ], ], 'BootstrapActionConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BootstrapActionConfig', ], ], 'BootstrapActionDetail' => [ 'type' => 'structure', 'members' => [ 'BootstrapActionConfig' => [ 'shape' => 'BootstrapActionConfig', ], ], ], 'BootstrapActionDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BootstrapActionDetail', ], ], 'CancelStepsInfo' => [ 'type' => 'structure', 'members' => [ 'StepId' => [ 'shape' => 'StepId', ], 'Status' => [ 'shape' => 'CancelStepsRequestStatus', ], 'Reason' => [ 'shape' => 'String', ], ], ], 'CancelStepsInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CancelStepsInfo', ], ], 'CancelStepsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'StepIds', ], 'members' => [ 'ClusterId' => [ 'shape' => 'XmlStringMaxLen256', ], 'StepIds' => [ 'shape' => 'StepIdsList', ], 'StepCancellationOption' => [ 'shape' => 'StepCancellationOption', ], ], ], 'CancelStepsOutput' => [ 'type' => 'structure', 'members' => [ 'CancelStepsInfoList' => [ 'shape' => 'CancelStepsInfoList', ], ], ], 'CancelStepsRequestStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'FAILED', ], ], 'CloudWatchAlarmDefinition' => [ 'type' => 'structure', 'required' => [ 'ComparisonOperator', 'MetricName', 'Period', 'Threshold', ], 'members' => [ 'ComparisonOperator' => [ 'shape' => 'ComparisonOperator', ], 'EvaluationPeriods' => [ 'shape' => 'Integer', ], 'MetricName' => [ 'shape' => 'String', ], 'Namespace' => [ 'shape' => 'String', ], 'Period' => [ 'shape' => 'Integer', ], 'Statistic' => [ 'shape' => 'Statistic', ], 'Threshold' => [ 'shape' => 'NonNegativeDouble', ], 'Unit' => [ 'shape' => 'Unit', ], 'Dimensions' => [ 'shape' => 'MetricDimensionList', ], ], ], 'Cluster' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ClusterId', ], 'Name' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ClusterStatus', ], 'Ec2InstanceAttributes' => [ 'shape' => 'Ec2InstanceAttributes', ], 'InstanceCollectionType' => [ 'shape' => 'InstanceCollectionType', ], 'LogUri' => [ 'shape' => 'String', ], 'LogEncryptionKmsKeyId' => [ 'shape' => 'String', ], 'RequestedAmiVersion' => [ 'shape' => 'String', ], 'RunningAmiVersion' => [ 'shape' => 'String', ], 'ReleaseLabel' => [ 'shape' => 'String', ], 'AutoTerminate' => [ 'shape' => 'Boolean', ], 'TerminationProtected' => [ 'shape' => 'Boolean', ], 'UnhealthyNodeReplacement' => [ 'shape' => 'BooleanObject', ], 'VisibleToAllUsers' => [ 'shape' => 'Boolean', ], 'Applications' => [ 'shape' => 'ApplicationList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ServiceRole' => [ 'shape' => 'String', ], 'NormalizedInstanceHours' => [ 'shape' => 'Integer', ], 'MasterPublicDnsName' => [ 'shape' => 'String', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'SecurityConfiguration' => [ 'shape' => 'XmlString', ], 'AutoScalingRole' => [ 'shape' => 'XmlString', ], 'ScaleDownBehavior' => [ 'shape' => 'ScaleDownBehavior', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EbsRootVolumeSize' => [ 'shape' => 'Integer', ], 'RepoUpgradeOnBoot' => [ 'shape' => 'RepoUpgradeOnBoot', ], 'KerberosAttributes' => [ 'shape' => 'KerberosAttributes', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], 'OutpostArn' => [ 'shape' => 'OptionalArnType', ], 'StepConcurrencyLevel' => [ 'shape' => 'Integer', ], 'PlacementGroups' => [ 'shape' => 'PlacementGroupConfigList', ], 'OSReleaseLabel' => [ 'shape' => 'String', ], 'EbsRootVolumeIops' => [ 'shape' => 'Integer', ], 'EbsRootVolumeThroughput' => [ 'shape' => 'Integer', ], ], ], 'ClusterId' => [ 'type' => 'string', ], 'ClusterState' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'BOOTSTRAPPING', 'RUNNING', 'WAITING', 'TERMINATING', 'TERMINATED', 'TERMINATED_WITH_ERRORS', ], ], 'ClusterStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'ClusterStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ClusterStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'VALIDATION_ERROR', 'INSTANCE_FAILURE', 'INSTANCE_FLEET_TIMEOUT', 'BOOTSTRAP_FAILURE', 'USER_REQUEST', 'STEP_FAILURE', 'ALL_STEPS_COMPLETED', ], ], 'ClusterStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterState', ], ], 'ClusterStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'ClusterState', ], 'StateChangeReason' => [ 'shape' => 'ClusterStateChangeReason', ], 'Timeline' => [ 'shape' => 'ClusterTimeline', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetailList', ], ], ], 'ClusterSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ClusterId', ], 'Name' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ClusterStatus', ], 'NormalizedInstanceHours' => [ 'shape' => 'Integer', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], 'OutpostArn' => [ 'shape' => 'OptionalArnType', ], ], ], 'ClusterSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterSummary', ], ], 'ClusterTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'Command' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'ScriptPath' => [ 'shape' => 'String', ], 'Args' => [ 'shape' => 'StringList', ], ], ], 'CommandList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Command', ], ], 'ComparisonOperator' => [ 'type' => 'string', 'enum' => [ 'GREATER_THAN_OR_EQUAL', 'GREATER_THAN', 'LESS_THAN', 'LESS_THAN_OR_EQUAL', ], ], 'ComputeLimits' => [ 'type' => 'structure', 'required' => [ 'UnitType', 'MinimumCapacityUnits', 'MaximumCapacityUnits', ], 'members' => [ 'UnitType' => [ 'shape' => 'ComputeLimitsUnitType', ], 'MinimumCapacityUnits' => [ 'shape' => 'Integer', ], 'MaximumCapacityUnits' => [ 'shape' => 'Integer', ], 'MaximumOnDemandCapacityUnits' => [ 'shape' => 'Integer', ], 'MaximumCoreCapacityUnits' => [ 'shape' => 'Integer', ], ], ], 'ComputeLimitsUnitType' => [ 'type' => 'string', 'enum' => [ 'InstanceFleetUnits', 'Instances', 'VCPU', ], ], 'Configuration' => [ 'type' => 'structure', 'members' => [ 'Classification' => [ 'shape' => 'String', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'Properties' => [ 'shape' => 'StringMap', ], ], ], 'ConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Configuration', ], ], 'CreateSecurityConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'SecurityConfiguration', ], 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], 'SecurityConfiguration' => [ 'shape' => 'String', ], ], ], 'CreateSecurityConfigurationOutput' => [ 'type' => 'structure', 'required' => [ 'Name', 'CreationDateTime', ], 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], 'CreationDateTime' => [ 'shape' => 'Date', ], ], ], 'CreateStudioInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'AuthMode', 'VpcId', 'SubnetIds', 'ServiceRole', 'WorkspaceSecurityGroupId', 'EngineSecurityGroupId', 'DefaultS3Location', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Description' => [ 'shape' => 'XmlStringMaxLen256', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'VpcId' => [ 'shape' => 'XmlStringMaxLen256', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'UserRole' => [ 'shape' => 'XmlString', ], 'WorkspaceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EngineSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'DefaultS3Location' => [ 'shape' => 'XmlString', ], 'IdpAuthUrl' => [ 'shape' => 'XmlString', ], 'IdpRelayStateParameterName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Tags' => [ 'shape' => 'TagList', ], 'TrustedIdentityPropagationEnabled' => [ 'shape' => 'BooleanObject', ], 'IdcUserAssignment' => [ 'shape' => 'IdcUserAssignment', ], 'IdcInstanceArn' => [ 'shape' => 'ArnType', ], 'EncryptionKeyArn' => [ 'shape' => 'XmlString', ], ], ], 'CreateStudioOutput' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Url' => [ 'shape' => 'XmlString', ], ], ], 'CreateStudioSessionMappingInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', 'IdentityType', 'SessionPolicyArn', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'SessionPolicyArn' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'Credentials' => [ 'type' => 'structure', 'members' => [ 'UsernamePassword' => [ 'shape' => 'UsernamePassword', ], ], 'union' => true, ], 'Date' => [ 'type' => 'timestamp', ], 'DeleteSecurityConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], ], ], 'DeleteSecurityConfigurationOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteStudioInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'DeleteStudioSessionMappingInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', 'IdentityType', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], ], ], 'DescribeClusterInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'DescribeClusterOutput' => [ 'type' => 'structure', 'members' => [ 'Cluster' => [ 'shape' => 'Cluster', ], ], ], 'DescribeJobFlowsInput' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Date', ], 'CreatedBefore' => [ 'shape' => 'Date', ], 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'JobFlowStates' => [ 'shape' => 'JobFlowExecutionStateList', ], ], ], 'DescribeJobFlowsOutput' => [ 'type' => 'structure', 'members' => [ 'JobFlows' => [ 'shape' => 'JobFlowDetailList', ], ], ], 'DescribeNotebookExecutionInput' => [ 'type' => 'structure', 'required' => [ 'NotebookExecutionId', ], 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'DescribeNotebookExecutionOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookExecution' => [ 'shape' => 'NotebookExecution', ], ], ], 'DescribeReleaseLabelInput' => [ 'type' => 'structure', 'members' => [ 'ReleaseLabel' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResultsNumber', ], ], ], 'DescribeReleaseLabelOutput' => [ 'type' => 'structure', 'members' => [ 'ReleaseLabel' => [ 'shape' => 'String', ], 'Applications' => [ 'shape' => 'SimplifiedApplicationList', ], 'NextToken' => [ 'shape' => 'String', ], 'AvailableOSReleases' => [ 'shape' => 'OSReleaseList', ], ], ], 'DescribeSecurityConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], ], ], 'DescribeSecurityConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], 'SecurityConfiguration' => [ 'shape' => 'String', ], 'CreationDateTime' => [ 'shape' => 'Date', ], ], ], 'DescribeStepInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'StepId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'StepId' => [ 'shape' => 'StepId', ], ], ], 'DescribeStepOutput' => [ 'type' => 'structure', 'members' => [ 'Step' => [ 'shape' => 'Step', ], ], ], 'DescribeStudioInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'DescribeStudioOutput' => [ 'type' => 'structure', 'members' => [ 'Studio' => [ 'shape' => 'Studio', ], ], ], 'EC2InstanceIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceId', ], ], 'EC2InstanceIdsToTerminateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceId', ], ], 'EbsBlockDevice' => [ 'type' => 'structure', 'members' => [ 'VolumeSpecification' => [ 'shape' => 'VolumeSpecification', ], 'Device' => [ 'shape' => 'String', ], ], ], 'EbsBlockDeviceConfig' => [ 'type' => 'structure', 'required' => [ 'VolumeSpecification', ], 'members' => [ 'VolumeSpecification' => [ 'shape' => 'VolumeSpecification', ], 'VolumesPerInstance' => [ 'shape' => 'Integer', ], ], ], 'EbsBlockDeviceConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EbsBlockDeviceConfig', ], ], 'EbsBlockDeviceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EbsBlockDevice', ], ], 'EbsConfiguration' => [ 'type' => 'structure', 'members' => [ 'EbsBlockDeviceConfigs' => [ 'shape' => 'EbsBlockDeviceConfigList', ], 'EbsOptimized' => [ 'shape' => 'BooleanObject', ], ], ], 'EbsVolume' => [ 'type' => 'structure', 'members' => [ 'Device' => [ 'shape' => 'String', ], 'VolumeId' => [ 'shape' => 'String', ], ], ], 'EbsVolumeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EbsVolume', ], ], 'Ec2InstanceAttributes' => [ 'type' => 'structure', 'members' => [ 'Ec2KeyName' => [ 'shape' => 'String', ], 'Ec2SubnetId' => [ 'shape' => 'String', ], 'RequestedEc2SubnetIds' => [ 'shape' => 'XmlStringMaxLen256List', ], 'Ec2AvailabilityZone' => [ 'shape' => 'String', ], 'RequestedEc2AvailabilityZones' => [ 'shape' => 'XmlStringMaxLen256List', ], 'IamInstanceProfile' => [ 'shape' => 'String', ], 'EmrManagedMasterSecurityGroup' => [ 'shape' => 'String', ], 'EmrManagedSlaveSecurityGroup' => [ 'shape' => 'String', ], 'ServiceAccessSecurityGroup' => [ 'shape' => 'String', ], 'AdditionalMasterSecurityGroups' => [ 'shape' => 'StringList', ], 'AdditionalSlaveSecurityGroups' => [ 'shape' => 'StringList', ], ], ], 'EnvironmentVariablesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'XmlStringMaxLen256', ], 'value' => [ 'shape' => 'XmlString', ], ], 'ErrorCode' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ErrorData' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringMap', ], ], 'ErrorDetail' => [ 'type' => 'structure', 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorData' => [ 'shape' => 'ErrorData', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'ErrorDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ErrorDetail', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'ExecutionEngineConfig' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'XmlStringMaxLen256', ], 'Type' => [ 'shape' => 'ExecutionEngineType', ], 'MasterInstanceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'ExecutionRoleArn' => [ 'shape' => 'IAMRoleArn', ], ], ], 'ExecutionEngineType' => [ 'type' => 'string', 'enum' => [ 'EMR', ], ], 'FailureDetails' => [ 'type' => 'structure', 'members' => [ 'Reason' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], 'LogFile' => [ 'shape' => 'String', ], ], ], 'Float' => [ 'type' => 'float', ], 'GetAutoTerminationPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'GetAutoTerminationPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'AutoTerminationPolicy' => [ 'shape' => 'AutoTerminationPolicy', ], ], ], 'GetBlockPublicAccessConfigurationInput' => [ 'type' => 'structure', 'members' => [], ], 'GetBlockPublicAccessConfigurationOutput' => [ 'type' => 'structure', 'required' => [ 'BlockPublicAccessConfiguration', 'BlockPublicAccessConfigurationMetadata', ], 'members' => [ 'BlockPublicAccessConfiguration' => [ 'shape' => 'BlockPublicAccessConfiguration', ], 'BlockPublicAccessConfigurationMetadata' => [ 'shape' => 'BlockPublicAccessConfigurationMetadata', ], ], ], 'GetClusterSessionCredentialsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'XmlStringMaxLen256', ], 'ExecutionRoleArn' => [ 'shape' => 'ArnType', ], ], ], 'GetClusterSessionCredentialsOutput' => [ 'type' => 'structure', 'members' => [ 'Credentials' => [ 'shape' => 'Credentials', ], 'ExpiresAt' => [ 'shape' => 'Date', ], ], ], 'GetManagedScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'GetManagedScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'ManagedScalingPolicy' => [ 'shape' => 'ManagedScalingPolicy', ], ], ], 'GetStudioSessionMappingInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', 'IdentityType', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], ], ], 'GetStudioSessionMappingOutput' => [ 'type' => 'structure', 'members' => [ 'SessionMapping' => [ 'shape' => 'SessionMappingDetail', ], ], ], 'HadoopJarStepConfig' => [ 'type' => 'structure', 'required' => [ 'Jar', ], 'members' => [ 'Properties' => [ 'shape' => 'KeyValueList', ], 'Jar' => [ 'shape' => 'XmlString', ], 'MainClass' => [ 'shape' => 'XmlString', ], 'Args' => [ 'shape' => 'XmlStringList', ], ], ], 'HadoopStepConfig' => [ 'type' => 'structure', 'members' => [ 'Jar' => [ 'shape' => 'String', ], 'Properties' => [ 'shape' => 'StringMap', ], 'MainClass' => [ 'shape' => 'String', ], 'Args' => [ 'shape' => 'StringList', ], ], ], 'IAMRoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$', ], 'IdcUserAssignment' => [ 'type' => 'string', 'enum' => [ 'REQUIRED', 'OPTIONAL', ], ], 'IdentityType' => [ 'type' => 'string', 'enum' => [ 'USER', 'GROUP', ], ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Ec2InstanceId' => [ 'shape' => 'InstanceId', ], 'PublicDnsName' => [ 'shape' => 'String', ], 'PublicIpAddress' => [ 'shape' => 'String', ], 'PrivateDnsName' => [ 'shape' => 'String', ], 'PrivateIpAddress' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'InstanceStatus', ], 'InstanceGroupId' => [ 'shape' => 'String', ], 'InstanceFleetId' => [ 'shape' => 'InstanceFleetId', ], 'Market' => [ 'shape' => 'MarketType', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'EbsVolumes' => [ 'shape' => 'EbsVolumeList', ], ], ], 'InstanceCollectionType' => [ 'type' => 'string', 'enum' => [ 'INSTANCE_FLEET', 'INSTANCE_GROUP', ], ], 'InstanceFleet' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceFleetId', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Status' => [ 'shape' => 'InstanceFleetStatus', ], 'InstanceFleetType' => [ 'shape' => 'InstanceFleetType', ], 'TargetOnDemandCapacity' => [ 'shape' => 'WholeNumber', ], 'TargetSpotCapacity' => [ 'shape' => 'WholeNumber', ], 'ProvisionedOnDemandCapacity' => [ 'shape' => 'WholeNumber', ], 'ProvisionedSpotCapacity' => [ 'shape' => 'WholeNumber', ], 'InstanceTypeSpecifications' => [ 'shape' => 'InstanceTypeSpecificationList', ], 'LaunchSpecifications' => [ 'shape' => 'InstanceFleetProvisioningSpecifications', ], 'ResizeSpecifications' => [ 'shape' => 'InstanceFleetResizingSpecifications', ], ], ], 'InstanceFleetConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceFleetType', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceFleetType' => [ 'shape' => 'InstanceFleetType', ], 'TargetOnDemandCapacity' => [ 'shape' => 'WholeNumber', ], 'TargetSpotCapacity' => [ 'shape' => 'WholeNumber', ], 'InstanceTypeConfigs' => [ 'shape' => 'InstanceTypeConfigList', ], 'LaunchSpecifications' => [ 'shape' => 'InstanceFleetProvisioningSpecifications', ], 'ResizeSpecifications' => [ 'shape' => 'InstanceFleetResizingSpecifications', ], ], ], 'InstanceFleetConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceFleetConfig', ], ], 'InstanceFleetId' => [ 'type' => 'string', ], 'InstanceFleetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceFleet', ], ], 'InstanceFleetModifyConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceFleetId', ], 'members' => [ 'InstanceFleetId' => [ 'shape' => 'InstanceFleetId', ], 'TargetOnDemandCapacity' => [ 'shape' => 'WholeNumber', ], 'TargetSpotCapacity' => [ 'shape' => 'WholeNumber', ], 'ResizeSpecifications' => [ 'shape' => 'InstanceFleetResizingSpecifications', ], ], ], 'InstanceFleetProvisioningSpecifications' => [ 'type' => 'structure', 'members' => [ 'SpotSpecification' => [ 'shape' => 'SpotProvisioningSpecification', ], 'OnDemandSpecification' => [ 'shape' => 'OnDemandProvisioningSpecification', ], ], ], 'InstanceFleetResizingSpecifications' => [ 'type' => 'structure', 'members' => [ 'SpotResizeSpecification' => [ 'shape' => 'SpotResizingSpecification', ], 'OnDemandResizeSpecification' => [ 'shape' => 'OnDemandResizingSpecification', ], ], ], 'InstanceFleetState' => [ 'type' => 'string', 'enum' => [ 'PROVISIONING', 'BOOTSTRAPPING', 'RUNNING', 'RESIZING', 'SUSPENDED', 'TERMINATING', 'TERMINATED', ], ], 'InstanceFleetStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'InstanceFleetStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'InstanceFleetStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'VALIDATION_ERROR', 'INSTANCE_FAILURE', 'CLUSTER_TERMINATED', ], ], 'InstanceFleetStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'InstanceFleetState', ], 'StateChangeReason' => [ 'shape' => 'InstanceFleetStateChangeReason', ], 'Timeline' => [ 'shape' => 'InstanceFleetTimeline', ], ], ], 'InstanceFleetTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'InstanceFleetType' => [ 'type' => 'string', 'enum' => [ 'MASTER', 'CORE', 'TASK', ], ], 'InstanceGroup' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceGroupId', ], 'Name' => [ 'shape' => 'String', ], 'Market' => [ 'shape' => 'MarketType', ], 'InstanceGroupType' => [ 'shape' => 'InstanceGroupType', ], 'BidPrice' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'RequestedInstanceCount' => [ 'shape' => 'Integer', ], 'RunningInstanceCount' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'InstanceGroupStatus', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'ConfigurationsVersion' => [ 'shape' => 'Long', ], 'LastSuccessfullyAppliedConfigurations' => [ 'shape' => 'ConfigurationList', ], 'LastSuccessfullyAppliedConfigurationsVersion' => [ 'shape' => 'Long', ], 'EbsBlockDevices' => [ 'shape' => 'EbsBlockDeviceList', ], 'EbsOptimized' => [ 'shape' => 'BooleanObject', ], 'ShrinkPolicy' => [ 'shape' => 'ShrinkPolicy', ], 'AutoScalingPolicy' => [ 'shape' => 'AutoScalingPolicyDescription', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'InstanceGroupConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceRole', 'InstanceType', 'InstanceCount', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Market' => [ 'shape' => 'MarketType', ], 'InstanceRole' => [ 'shape' => 'InstanceRoleType', ], 'BidPrice' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'EbsConfiguration' => [ 'shape' => 'EbsConfiguration', ], 'AutoScalingPolicy' => [ 'shape' => 'AutoScalingPolicy', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'InstanceGroupConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupConfig', ], ], 'InstanceGroupDetail' => [ 'type' => 'structure', 'required' => [ 'Market', 'InstanceRole', 'InstanceType', 'InstanceRequestCount', 'InstanceRunningCount', 'State', 'CreationDateTime', ], 'members' => [ 'InstanceGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Market' => [ 'shape' => 'MarketType', ], 'InstanceRole' => [ 'shape' => 'InstanceRoleType', ], 'BidPrice' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceRequestCount' => [ 'shape' => 'Integer', ], 'InstanceRunningCount' => [ 'shape' => 'Integer', ], 'State' => [ 'shape' => 'InstanceGroupState', ], 'LastStateChangeReason' => [ 'shape' => 'XmlString', ], 'CreationDateTime' => [ 'shape' => 'Date', ], 'StartDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'InstanceGroupDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupDetail', ], ], 'InstanceGroupId' => [ 'type' => 'string', ], 'InstanceGroupIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'InstanceGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroup', ], ], 'InstanceGroupModifyConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceGroupId', ], 'members' => [ 'InstanceGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'EC2InstanceIdsToTerminate' => [ 'shape' => 'EC2InstanceIdsToTerminateList', ], 'ShrinkPolicy' => [ 'shape' => 'ShrinkPolicy', ], 'ReconfigurationType' => [ 'shape' => 'ReconfigurationType', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], ], ], 'InstanceGroupModifyConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupModifyConfig', ], ], 'InstanceGroupState' => [ 'type' => 'string', 'enum' => [ 'PROVISIONING', 'BOOTSTRAPPING', 'RUNNING', 'RECONFIGURING', 'RESIZING', 'SUSPENDED', 'TERMINATING', 'TERMINATED', 'ARRESTED', 'SHUTTING_DOWN', 'ENDED', ], ], 'InstanceGroupStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'InstanceGroupStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'InstanceGroupStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'VALIDATION_ERROR', 'INSTANCE_FAILURE', 'CLUSTER_TERMINATED', ], ], 'InstanceGroupStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'InstanceGroupState', ], 'StateChangeReason' => [ 'shape' => 'InstanceGroupStateChangeReason', ], 'Timeline' => [ 'shape' => 'InstanceGroupTimeline', ], ], ], 'InstanceGroupTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'InstanceGroupType' => [ 'type' => 'string', 'enum' => [ 'MASTER', 'CORE', 'TASK', ], ], 'InstanceGroupTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupType', ], ], 'InstanceId' => [ 'type' => 'string', ], 'InstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Instance', ], ], 'InstanceResizePolicy' => [ 'type' => 'structure', 'members' => [ 'InstancesToTerminate' => [ 'shape' => 'EC2InstanceIdsList', ], 'InstancesToProtect' => [ 'shape' => 'EC2InstanceIdsList', ], 'InstanceTerminationTimeout' => [ 'shape' => 'Integer', ], ], ], 'InstanceRoleType' => [ 'type' => 'string', 'enum' => [ 'MASTER', 'CORE', 'TASK', ], ], 'InstanceState' => [ 'type' => 'string', 'enum' => [ 'AWAITING_FULFILLMENT', 'PROVISIONING', 'BOOTSTRAPPING', 'RUNNING', 'TERMINATED', ], ], 'InstanceStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'InstanceStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'InstanceStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'VALIDATION_ERROR', 'INSTANCE_FAILURE', 'BOOTSTRAP_FAILURE', 'CLUSTER_TERMINATED', ], ], 'InstanceStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceState', ], ], 'InstanceStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'InstanceState', ], 'StateChangeReason' => [ 'shape' => 'InstanceStateChangeReason', ], 'Timeline' => [ 'shape' => 'InstanceTimeline', ], ], ], 'InstanceTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'InstanceType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*', ], 'InstanceTypeConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', ], 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'WeightedCapacity' => [ 'shape' => 'WholeNumber', ], 'BidPrice' => [ 'shape' => 'XmlStringMaxLen256', ], 'BidPriceAsPercentageOfOnDemandPrice' => [ 'shape' => 'NonNegativeDouble', ], 'EbsConfiguration' => [ 'shape' => 'EbsConfiguration', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'InstanceTypeConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceTypeConfig', ], ], 'InstanceTypeSpecification' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'WeightedCapacity' => [ 'shape' => 'WholeNumber', ], 'BidPrice' => [ 'shape' => 'XmlStringMaxLen256', ], 'BidPriceAsPercentageOfOnDemandPrice' => [ 'shape' => 'NonNegativeDouble', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'EbsBlockDevices' => [ 'shape' => 'EbsBlockDeviceList', ], 'EbsOptimized' => [ 'shape' => 'BooleanObject', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'InstanceTypeSpecificationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceTypeSpecification', ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalServerError' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, 'fault' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'ErrorCode' => [ 'shape' => 'ErrorCode', ], 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'JobFlowDetail' => [ 'type' => 'structure', 'required' => [ 'JobFlowId', 'Name', 'ExecutionStatusDetail', 'Instances', ], 'members' => [ 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'LogUri' => [ 'shape' => 'XmlString', ], 'LogEncryptionKmsKeyId' => [ 'shape' => 'XmlString', ], 'AmiVersion' => [ 'shape' => 'XmlStringMaxLen256', ], 'ExecutionStatusDetail' => [ 'shape' => 'JobFlowExecutionStatusDetail', ], 'Instances' => [ 'shape' => 'JobFlowInstancesDetail', ], 'Steps' => [ 'shape' => 'StepDetailList', ], 'BootstrapActions' => [ 'shape' => 'BootstrapActionDetailList', ], 'SupportedProducts' => [ 'shape' => 'SupportedProductsList', ], 'VisibleToAllUsers' => [ 'shape' => 'Boolean', ], 'JobFlowRole' => [ 'shape' => 'XmlString', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'AutoScalingRole' => [ 'shape' => 'XmlString', ], 'ScaleDownBehavior' => [ 'shape' => 'ScaleDownBehavior', ], ], ], 'JobFlowDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'JobFlowDetail', ], ], 'JobFlowExecutionState' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'BOOTSTRAPPING', 'RUNNING', 'WAITING', 'SHUTTING_DOWN', 'TERMINATED', 'COMPLETED', 'FAILED', ], ], 'JobFlowExecutionStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'JobFlowExecutionState', ], ], 'JobFlowExecutionStatusDetail' => [ 'type' => 'structure', 'required' => [ 'State', 'CreationDateTime', ], 'members' => [ 'State' => [ 'shape' => 'JobFlowExecutionState', ], 'CreationDateTime' => [ 'shape' => 'Date', ], 'StartDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], 'LastStateChangeReason' => [ 'shape' => 'XmlString', ], ], ], 'JobFlowInstancesConfig' => [ 'type' => 'structure', 'members' => [ 'MasterInstanceType' => [ 'shape' => 'InstanceType', ], 'SlaveInstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroupConfigList', ], 'InstanceFleets' => [ 'shape' => 'InstanceFleetConfigList', ], 'Ec2KeyName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Placement' => [ 'shape' => 'PlacementType', ], 'KeepJobFlowAliveWhenNoSteps' => [ 'shape' => 'Boolean', ], 'TerminationProtected' => [ 'shape' => 'Boolean', ], 'UnhealthyNodeReplacement' => [ 'shape' => 'BooleanObject', ], 'HadoopVersion' => [ 'shape' => 'XmlStringMaxLen256', ], 'Ec2SubnetId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Ec2SubnetIds' => [ 'shape' => 'XmlStringMaxLen256List', ], 'EmrManagedMasterSecurityGroup' => [ 'shape' => 'XmlStringMaxLen256', ], 'EmrManagedSlaveSecurityGroup' => [ 'shape' => 'XmlStringMaxLen256', ], 'ServiceAccessSecurityGroup' => [ 'shape' => 'XmlStringMaxLen256', ], 'AdditionalMasterSecurityGroups' => [ 'shape' => 'SecurityGroupsList', ], 'AdditionalSlaveSecurityGroups' => [ 'shape' => 'SecurityGroupsList', ], ], ], 'JobFlowInstancesDetail' => [ 'type' => 'structure', 'required' => [ 'MasterInstanceType', 'SlaveInstanceType', 'InstanceCount', ], 'members' => [ 'MasterInstanceType' => [ 'shape' => 'InstanceType', ], 'MasterPublicDnsName' => [ 'shape' => 'XmlString', ], 'MasterInstanceId' => [ 'shape' => 'XmlString', ], 'SlaveInstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroupDetailList', ], 'NormalizedInstanceHours' => [ 'shape' => 'Integer', ], 'Ec2KeyName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Ec2SubnetId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Placement' => [ 'shape' => 'PlacementType', ], 'KeepJobFlowAliveWhenNoSteps' => [ 'shape' => 'Boolean', ], 'TerminationProtected' => [ 'shape' => 'Boolean', ], 'UnhealthyNodeReplacement' => [ 'shape' => 'BooleanObject', ], 'HadoopVersion' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'KerberosAttributes' => [ 'type' => 'structure', 'required' => [ 'Realm', 'KdcAdminPassword', ], 'members' => [ 'Realm' => [ 'shape' => 'XmlStringMaxLen256', ], 'KdcAdminPassword' => [ 'shape' => 'XmlStringMaxLen256', ], 'CrossRealmTrustPrincipalPassword' => [ 'shape' => 'XmlStringMaxLen256', ], 'ADDomainJoinUser' => [ 'shape' => 'XmlStringMaxLen256', ], 'ADDomainJoinPassword' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'KeyValue' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'XmlString', ], 'Value' => [ 'shape' => 'XmlString', ], ], ], 'KeyValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValue', ], ], 'ListBootstrapActionsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListBootstrapActionsOutput' => [ 'type' => 'structure', 'members' => [ 'BootstrapActions' => [ 'shape' => 'CommandList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListClustersInput' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Date', ], 'CreatedBefore' => [ 'shape' => 'Date', ], 'ClusterStates' => [ 'shape' => 'ClusterStateList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListClustersOutput' => [ 'type' => 'structure', 'members' => [ 'Clusters' => [ 'shape' => 'ClusterSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstanceFleetsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstanceFleetsOutput' => [ 'type' => 'structure', 'members' => [ 'InstanceFleets' => [ 'shape' => 'InstanceFleetList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstanceGroupsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstanceGroupsOutput' => [ 'type' => 'structure', 'members' => [ 'InstanceGroups' => [ 'shape' => 'InstanceGroupList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstancesInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroupId' => [ 'shape' => 'InstanceGroupId', ], 'InstanceGroupTypes' => [ 'shape' => 'InstanceGroupTypeList', ], 'InstanceFleetId' => [ 'shape' => 'InstanceFleetId', ], 'InstanceFleetType' => [ 'shape' => 'InstanceFleetType', ], 'InstanceStates' => [ 'shape' => 'InstanceStateList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'Instances' => [ 'shape' => 'InstanceList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListNotebookExecutionsInput' => [ 'type' => 'structure', 'members' => [ 'EditorId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Status' => [ 'shape' => 'NotebookExecutionStatus', ], 'From' => [ 'shape' => 'Date', ], 'To' => [ 'shape' => 'Date', ], 'Marker' => [ 'shape' => 'Marker', ], 'ExecutionEngineId' => [ 'shape' => 'XmlString', ], ], ], 'ListNotebookExecutionsOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookExecutions' => [ 'shape' => 'NotebookExecutionSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListReleaseLabelsInput' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ReleaseLabelFilter', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResultsNumber', ], ], ], 'ListReleaseLabelsOutput' => [ 'type' => 'structure', 'members' => [ 'ReleaseLabels' => [ 'shape' => 'StringList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListSecurityConfigurationsInput' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListSecurityConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'SecurityConfigurations' => [ 'shape' => 'SecurityConfigurationList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStepsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'StepStates' => [ 'shape' => 'StepStateList', ], 'StepIds' => [ 'shape' => 'XmlStringList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStepsOutput' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'StepSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStudioSessionMappingsInput' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStudioSessionMappingsOutput' => [ 'type' => 'structure', 'members' => [ 'SessionMappings' => [ 'shape' => 'SessionMappingSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStudiosInput' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStudiosOutput' => [ 'type' => 'structure', 'members' => [ 'Studios' => [ 'shape' => 'StudioSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListSupportedInstanceTypesInput' => [ 'type' => 'structure', 'required' => [ 'ReleaseLabel', ], 'members' => [ 'ReleaseLabel' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'ListSupportedInstanceTypesOutput' => [ 'type' => 'structure', 'members' => [ 'SupportedInstanceTypes' => [ 'shape' => 'SupportedInstanceTypesList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'Long' => [ 'type' => 'long', ], 'ManagedScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'ComputeLimits' => [ 'shape' => 'ComputeLimits', ], ], ], 'Marker' => [ 'type' => 'string', ], 'MarketType' => [ 'type' => 'string', 'enum' => [ 'ON_DEMAND', 'SPOT', ], ], 'MaxResultsNumber' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MetricDimension' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'MetricDimensionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDimension', ], ], 'ModifyClusterInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'String', ], 'StepConcurrencyLevel' => [ 'shape' => 'Integer', ], ], ], 'ModifyClusterOutput' => [ 'type' => 'structure', 'members' => [ 'StepConcurrencyLevel' => [ 'shape' => 'Integer', ], ], ], 'ModifyInstanceFleetInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'InstanceFleet', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceFleet' => [ 'shape' => 'InstanceFleetModifyConfig', ], ], ], 'ModifyInstanceGroupsInput' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroupModifyConfigList', ], ], ], 'NewSupportedProductsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SupportedProductConfig', ], ], 'NonNegativeDouble' => [ 'type' => 'double', 'min' => 0.0, ], 'NotebookExecution' => [ 'type' => 'structure', 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EditorId' => [ 'shape' => 'XmlStringMaxLen256', ], 'ExecutionEngine' => [ 'shape' => 'ExecutionEngineConfig', ], 'NotebookExecutionName' => [ 'shape' => 'XmlStringMaxLen256', ], 'NotebookParams' => [ 'shape' => 'XmlString', ], 'Status' => [ 'shape' => 'NotebookExecutionStatus', ], 'StartTime' => [ 'shape' => 'Date', ], 'EndTime' => [ 'shape' => 'Date', ], 'Arn' => [ 'shape' => 'XmlStringMaxLen256', ], 'OutputNotebookURI' => [ 'shape' => 'XmlString', ], 'LastStateChangeReason' => [ 'shape' => 'XmlString', ], 'NotebookInstanceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Tags' => [ 'shape' => 'TagList', ], 'NotebookS3Location' => [ 'shape' => 'NotebookS3LocationForOutput', ], 'OutputNotebookS3Location' => [ 'shape' => 'OutputNotebookS3LocationForOutput', ], 'OutputNotebookFormat' => [ 'shape' => 'OutputNotebookFormat', ], 'EnvironmentVariables' => [ 'shape' => 'EnvironmentVariablesMap', ], ], ], 'NotebookExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'START_PENDING', 'STARTING', 'RUNNING', 'FINISHING', 'FINISHED', 'FAILING', 'FAILED', 'STOP_PENDING', 'STOPPING', 'STOPPED', ], ], 'NotebookExecutionSummary' => [ 'type' => 'structure', 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EditorId' => [ 'shape' => 'XmlStringMaxLen256', ], 'NotebookExecutionName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Status' => [ 'shape' => 'NotebookExecutionStatus', ], 'StartTime' => [ 'shape' => 'Date', ], 'EndTime' => [ 'shape' => 'Date', ], 'NotebookS3Location' => [ 'shape' => 'NotebookS3LocationForOutput', ], 'ExecutionEngineId' => [ 'shape' => 'XmlString', ], ], ], 'NotebookExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookExecutionSummary', ], ], 'NotebookS3LocationForOutput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'XmlStringMaxLen256', ], 'Key' => [ 'shape' => 'UriString', ], ], ], 'NotebookS3LocationFromInput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'XmlStringMaxLen256', ], 'Key' => [ 'shape' => 'UriString', ], ], ], 'OSRelease' => [ 'type' => 'structure', 'members' => [ 'Label' => [ 'shape' => 'String', ], ], ], 'OSReleaseList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OSRelease', ], ], 'OnDemandCapacityReservationOptions' => [ 'type' => 'structure', 'members' => [ 'UsageStrategy' => [ 'shape' => 'OnDemandCapacityReservationUsageStrategy', ], 'CapacityReservationPreference' => [ 'shape' => 'OnDemandCapacityReservationPreference', ], 'CapacityReservationResourceGroupArn' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'OnDemandCapacityReservationPreference' => [ 'type' => 'string', 'enum' => [ 'open', 'none', ], ], 'OnDemandCapacityReservationUsageStrategy' => [ 'type' => 'string', 'enum' => [ 'use-capacity-reservations-first', ], ], 'OnDemandProvisioningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'lowest-price', ], ], 'OnDemandProvisioningSpecification' => [ 'type' => 'structure', 'required' => [ 'AllocationStrategy', ], 'members' => [ 'AllocationStrategy' => [ 'shape' => 'OnDemandProvisioningAllocationStrategy', ], 'CapacityReservationOptions' => [ 'shape' => 'OnDemandCapacityReservationOptions', ], ], ], 'OnDemandResizingSpecification' => [ 'type' => 'structure', 'required' => [ 'TimeoutDurationMinutes', ], 'members' => [ 'TimeoutDurationMinutes' => [ 'shape' => 'WholeNumber', ], ], ], 'OptionalArnType' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'OutputNotebookFormat' => [ 'type' => 'string', 'enum' => [ 'HTML', ], ], 'OutputNotebookS3LocationForOutput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'XmlStringMaxLen256', ], 'Key' => [ 'shape' => 'UriString', ], ], ], 'OutputNotebookS3LocationFromInput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'XmlStringMaxLen256', ], 'Key' => [ 'shape' => 'UriString', ], ], ], 'PlacementGroupConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceRole', ], 'members' => [ 'InstanceRole' => [ 'shape' => 'InstanceRoleType', ], 'PlacementStrategy' => [ 'shape' => 'PlacementGroupStrategy', ], ], ], 'PlacementGroupConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementGroupConfig', ], ], 'PlacementGroupStrategy' => [ 'type' => 'string', 'enum' => [ 'SPREAD', 'PARTITION', 'CLUSTER', 'NONE', ], ], 'PlacementType' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZone' => [ 'shape' => 'XmlString', ], 'AvailabilityZones' => [ 'shape' => 'XmlStringMaxLen256List', ], ], ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => -1, ], 'PortRange' => [ 'type' => 'structure', 'required' => [ 'MinRange', ], 'members' => [ 'MinRange' => [ 'shape' => 'Port', ], 'MaxRange' => [ 'shape' => 'Port', ], ], ], 'PortRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortRange', ], ], 'PutAutoScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'InstanceGroupId', 'AutoScalingPolicy', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroupId' => [ 'shape' => 'InstanceGroupId', ], 'AutoScalingPolicy' => [ 'shape' => 'AutoScalingPolicy', ], ], ], 'PutAutoScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroupId' => [ 'shape' => 'InstanceGroupId', ], 'AutoScalingPolicy' => [ 'shape' => 'AutoScalingPolicyDescription', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], ], ], 'PutAutoTerminationPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'AutoTerminationPolicy' => [ 'shape' => 'AutoTerminationPolicy', ], ], ], 'PutAutoTerminationPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'PutBlockPublicAccessConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'BlockPublicAccessConfiguration', ], 'members' => [ 'BlockPublicAccessConfiguration' => [ 'shape' => 'BlockPublicAccessConfiguration', ], ], ], 'PutBlockPublicAccessConfigurationOutput' => [ 'type' => 'structure', 'members' => [], ], 'PutManagedScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'ManagedScalingPolicy', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'ManagedScalingPolicy' => [ 'shape' => 'ManagedScalingPolicy', ], ], ], 'PutManagedScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'ReconfigurationType' => [ 'type' => 'string', 'enum' => [ 'OVERWRITE', 'MERGE', ], ], 'ReleaseLabelFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'String', ], 'Application' => [ 'shape' => 'String', ], ], ], 'RemoveAutoScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'InstanceGroupId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroupId' => [ 'shape' => 'InstanceGroupId', ], ], ], 'RemoveAutoScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'RemoveAutoTerminationPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'RemoveAutoTerminationPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'RemoveManagedScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'RemoveManagedScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'RemoveTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagKeys', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'RemoveTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'RepoUpgradeOnBoot' => [ 'type' => 'string', 'enum' => [ 'SECURITY', 'NONE', ], ], 'ResourceId' => [ 'type' => 'string', ], 'RunJobFlowInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'Instances', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'LogUri' => [ 'shape' => 'XmlString', ], 'LogEncryptionKmsKeyId' => [ 'shape' => 'XmlString', ], 'AdditionalInfo' => [ 'shape' => 'XmlString', ], 'AmiVersion' => [ 'shape' => 'XmlStringMaxLen256', ], 'ReleaseLabel' => [ 'shape' => 'XmlStringMaxLen256', ], 'Instances' => [ 'shape' => 'JobFlowInstancesConfig', ], 'Steps' => [ 'shape' => 'StepConfigList', ], 'BootstrapActions' => [ 'shape' => 'BootstrapActionConfigList', ], 'SupportedProducts' => [ 'shape' => 'SupportedProductsList', ], 'NewSupportedProducts' => [ 'shape' => 'NewSupportedProductsList', ], 'Applications' => [ 'shape' => 'ApplicationList', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'VisibleToAllUsers' => [ 'shape' => 'Boolean', ], 'JobFlowRole' => [ 'shape' => 'XmlString', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'Tags' => [ 'shape' => 'TagList', ], 'SecurityConfiguration' => [ 'shape' => 'XmlString', ], 'AutoScalingRole' => [ 'shape' => 'XmlString', ], 'ScaleDownBehavior' => [ 'shape' => 'ScaleDownBehavior', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EbsRootVolumeSize' => [ 'shape' => 'Integer', ], 'RepoUpgradeOnBoot' => [ 'shape' => 'RepoUpgradeOnBoot', ], 'KerberosAttributes' => [ 'shape' => 'KerberosAttributes', ], 'StepConcurrencyLevel' => [ 'shape' => 'Integer', ], 'ManagedScalingPolicy' => [ 'shape' => 'ManagedScalingPolicy', ], 'PlacementGroupConfigs' => [ 'shape' => 'PlacementGroupConfigList', ], 'AutoTerminationPolicy' => [ 'shape' => 'AutoTerminationPolicy', ], 'OSReleaseLabel' => [ 'shape' => 'XmlStringMaxLen256', ], 'EbsRootVolumeIops' => [ 'shape' => 'Integer', ], 'EbsRootVolumeThroughput' => [ 'shape' => 'Integer', ], ], ], 'RunJobFlowOutput' => [ 'type' => 'structure', 'members' => [ 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], ], ], 'ScaleDownBehavior' => [ 'type' => 'string', 'enum' => [ 'TERMINATE_AT_INSTANCE_HOUR', 'TERMINATE_AT_TASK_COMPLETION', ], ], 'ScalingAction' => [ 'type' => 'structure', 'required' => [ 'SimpleScalingPolicyConfiguration', ], 'members' => [ 'Market' => [ 'shape' => 'MarketType', ], 'SimpleScalingPolicyConfiguration' => [ 'shape' => 'SimpleScalingPolicyConfiguration', ], ], ], 'ScalingConstraints' => [ 'type' => 'structure', 'required' => [ 'MinCapacity', 'MaxCapacity', ], 'members' => [ 'MinCapacity' => [ 'shape' => 'Integer', ], 'MaxCapacity' => [ 'shape' => 'Integer', ], ], ], 'ScalingRule' => [ 'type' => 'structure', 'required' => [ 'Name', 'Action', 'Trigger', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Action' => [ 'shape' => 'ScalingAction', ], 'Trigger' => [ 'shape' => 'ScalingTrigger', ], ], ], 'ScalingRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingRule', ], ], 'ScalingTrigger' => [ 'type' => 'structure', 'required' => [ 'CloudWatchAlarmDefinition', ], 'members' => [ 'CloudWatchAlarmDefinition' => [ 'shape' => 'CloudWatchAlarmDefinition', ], ], ], 'ScriptBootstrapActionConfig' => [ 'type' => 'structure', 'required' => [ 'Path', ], 'members' => [ 'Path' => [ 'shape' => 'XmlString', ], 'Args' => [ 'shape' => 'XmlStringList', ], ], ], 'SecurityConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityConfigurationSummary', ], ], 'SecurityConfigurationSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], 'CreationDateTime' => [ 'shape' => 'Date', ], ], ], 'SecurityGroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'SessionMappingDetail' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'SessionPolicyArn' => [ 'shape' => 'XmlStringMaxLen256', ], 'CreationTime' => [ 'shape' => 'Date', ], 'LastModifiedTime' => [ 'shape' => 'Date', ], ], ], 'SessionMappingSummary' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'SessionPolicyArn' => [ 'shape' => 'XmlStringMaxLen256', ], 'CreationTime' => [ 'shape' => 'Date', ], ], ], 'SessionMappingSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SessionMappingSummary', ], ], 'SetKeepJobFlowAliveWhenNoStepsInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', 'KeepJobFlowAliveWhenNoSteps', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'KeepJobFlowAliveWhenNoSteps' => [ 'shape' => 'Boolean', ], ], ], 'SetTerminationProtectionInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', 'TerminationProtected', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'TerminationProtected' => [ 'shape' => 'Boolean', ], ], ], 'SetUnhealthyNodeReplacementInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', 'UnhealthyNodeReplacement', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'UnhealthyNodeReplacement' => [ 'shape' => 'BooleanObject', ], ], ], 'SetVisibleToAllUsersInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', 'VisibleToAllUsers', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'VisibleToAllUsers' => [ 'shape' => 'Boolean', ], ], ], 'ShrinkPolicy' => [ 'type' => 'structure', 'members' => [ 'DecommissionTimeout' => [ 'shape' => 'Integer', ], 'InstanceResizePolicy' => [ 'shape' => 'InstanceResizePolicy', ], ], ], 'SimpleScalingPolicyConfiguration' => [ 'type' => 'structure', 'required' => [ 'ScalingAdjustment', ], 'members' => [ 'AdjustmentType' => [ 'shape' => 'AdjustmentType', ], 'ScalingAdjustment' => [ 'shape' => 'Integer', ], 'CoolDown' => [ 'shape' => 'Integer', ], ], ], 'SimplifiedApplication' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Version' => [ 'shape' => 'String', ], ], ], 'SimplifiedApplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SimplifiedApplication', ], ], 'SpotProvisioningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'capacity-optimized', 'price-capacity-optimized', 'lowest-price', 'diversified', ], ], 'SpotProvisioningSpecification' => [ 'type' => 'structure', 'required' => [ 'TimeoutDurationMinutes', 'TimeoutAction', ], 'members' => [ 'TimeoutDurationMinutes' => [ 'shape' => 'WholeNumber', ], 'TimeoutAction' => [ 'shape' => 'SpotProvisioningTimeoutAction', ], 'BlockDurationMinutes' => [ 'shape' => 'WholeNumber', ], 'AllocationStrategy' => [ 'shape' => 'SpotProvisioningAllocationStrategy', ], ], ], 'SpotProvisioningTimeoutAction' => [ 'type' => 'string', 'enum' => [ 'SWITCH_TO_ON_DEMAND', 'TERMINATE_CLUSTER', ], ], 'SpotResizingSpecification' => [ 'type' => 'structure', 'required' => [ 'TimeoutDurationMinutes', ], 'members' => [ 'TimeoutDurationMinutes' => [ 'shape' => 'WholeNumber', ], ], ], 'StartNotebookExecutionInput' => [ 'type' => 'structure', 'required' => [ 'ExecutionEngine', 'ServiceRole', ], 'members' => [ 'EditorId' => [ 'shape' => 'XmlStringMaxLen256', ], 'RelativePath' => [ 'shape' => 'XmlString', ], 'NotebookExecutionName' => [ 'shape' => 'XmlStringMaxLen256', ], 'NotebookParams' => [ 'shape' => 'XmlString', ], 'ExecutionEngine' => [ 'shape' => 'ExecutionEngineConfig', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'NotebookInstanceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Tags' => [ 'shape' => 'TagList', ], 'NotebookS3Location' => [ 'shape' => 'NotebookS3LocationFromInput', ], 'OutputNotebookS3Location' => [ 'shape' => 'OutputNotebookS3LocationFromInput', ], 'OutputNotebookFormat' => [ 'shape' => 'OutputNotebookFormat', ], 'EnvironmentVariables' => [ 'shape' => 'EnvironmentVariablesMap', ], ], ], 'StartNotebookExecutionOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'SAMPLE_COUNT', 'AVERAGE', 'SUM', 'MINIMUM', 'MAXIMUM', ], ], 'Step' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'StepId', ], 'Name' => [ 'shape' => 'String', ], 'Config' => [ 'shape' => 'HadoopStepConfig', ], 'ActionOnFailure' => [ 'shape' => 'ActionOnFailure', ], 'Status' => [ 'shape' => 'StepStatus', ], 'ExecutionRoleArn' => [ 'shape' => 'OptionalArnType', ], ], ], 'StepCancellationOption' => [ 'type' => 'string', 'enum' => [ 'SEND_INTERRUPT', 'TERMINATE_PROCESS', ], ], 'StepConfig' => [ 'type' => 'structure', 'required' => [ 'Name', 'HadoopJarStep', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'ActionOnFailure' => [ 'shape' => 'ActionOnFailure', ], 'HadoopJarStep' => [ 'shape' => 'HadoopJarStepConfig', ], ], ], 'StepConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StepConfig', ], ], 'StepDetail' => [ 'type' => 'structure', 'required' => [ 'StepConfig', 'ExecutionStatusDetail', ], 'members' => [ 'StepConfig' => [ 'shape' => 'StepConfig', ], 'ExecutionStatusDetail' => [ 'shape' => 'StepExecutionStatusDetail', ], ], ], 'StepDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StepDetail', ], ], 'StepExecutionState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'RUNNING', 'CONTINUE', 'COMPLETED', 'CANCELLED', 'FAILED', 'INTERRUPTED', ], ], 'StepExecutionStatusDetail' => [ 'type' => 'structure', 'required' => [ 'State', 'CreationDateTime', ], 'members' => [ 'State' => [ 'shape' => 'StepExecutionState', ], 'CreationDateTime' => [ 'shape' => 'Date', ], 'StartDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], 'LastStateChangeReason' => [ 'shape' => 'XmlString', ], ], ], 'StepId' => [ 'type' => 'string', ], 'StepIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'StepState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'CANCEL_PENDING', 'RUNNING', 'COMPLETED', 'CANCELLED', 'FAILED', 'INTERRUPTED', ], ], 'StepStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'StepStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'StepStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'NONE', ], ], 'StepStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StepState', ], ], 'StepStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'StepState', ], 'StateChangeReason' => [ 'shape' => 'StepStateChangeReason', ], 'FailureDetails' => [ 'shape' => 'FailureDetails', ], 'Timeline' => [ 'shape' => 'StepTimeline', ], ], ], 'StepSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'StepId', ], 'Name' => [ 'shape' => 'String', ], 'Config' => [ 'shape' => 'HadoopStepConfig', ], 'ActionOnFailure' => [ 'shape' => 'ActionOnFailure', ], 'Status' => [ 'shape' => 'StepStatus', ], ], ], 'StepSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StepSummary', ], ], 'StepTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'StartDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'StopNotebookExecutionInput' => [ 'type' => 'structure', 'required' => [ 'NotebookExecutionId', ], 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'Studio' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'StudioArn' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Description' => [ 'shape' => 'XmlStringMaxLen256', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'VpcId' => [ 'shape' => 'XmlStringMaxLen256', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'UserRole' => [ 'shape' => 'XmlString', ], 'WorkspaceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EngineSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Url' => [ 'shape' => 'XmlString', ], 'CreationTime' => [ 'shape' => 'Date', ], 'DefaultS3Location' => [ 'shape' => 'XmlString', ], 'IdpAuthUrl' => [ 'shape' => 'XmlString', ], 'IdpRelayStateParameterName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Tags' => [ 'shape' => 'TagList', ], 'IdcInstanceArn' => [ 'shape' => 'ArnType', ], 'TrustedIdentityPropagationEnabled' => [ 'shape' => 'BooleanObject', ], 'IdcUserAssignment' => [ 'shape' => 'IdcUserAssignment', ], 'EncryptionKeyArn' => [ 'shape' => 'XmlString', ], ], ], 'StudioSummary' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'VpcId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Description' => [ 'shape' => 'XmlStringMaxLen256', ], 'Url' => [ 'shape' => 'XmlStringMaxLen256', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'CreationTime' => [ 'shape' => 'Date', ], ], ], 'StudioSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioSummary', ], ], 'SubnetIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'SupportedInstanceType' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'MemoryGB' => [ 'shape' => 'Float', ], 'StorageGB' => [ 'shape' => 'Integer', ], 'VCPU' => [ 'shape' => 'Integer', ], 'Is64BitsOnly' => [ 'shape' => 'Boolean', ], 'InstanceFamilyId' => [ 'shape' => 'String', ], 'EbsOptimizedAvailable' => [ 'shape' => 'Boolean', ], 'EbsOptimizedByDefault' => [ 'shape' => 'Boolean', ], 'NumberOfDisks' => [ 'shape' => 'Integer', ], 'EbsStorageOnly' => [ 'shape' => 'Boolean', ], 'Architecture' => [ 'shape' => 'String', ], ], ], 'SupportedInstanceTypesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SupportedInstanceType', ], ], 'SupportedProductConfig' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Args' => [ 'shape' => 'XmlStringList', ], ], ], 'SupportedProductsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TerminateJobFlowsInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], ], ], 'ThroughputVal' => [ 'type' => 'integer', 'min' => 0, ], 'Unit' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SECONDS', 'MICRO_SECONDS', 'MILLI_SECONDS', 'BYTES', 'KILO_BYTES', 'MEGA_BYTES', 'GIGA_BYTES', 'TERA_BYTES', 'BITS', 'KILO_BITS', 'MEGA_BITS', 'GIGA_BITS', 'TERA_BITS', 'PERCENT', 'COUNT', 'BYTES_PER_SECOND', 'KILO_BYTES_PER_SECOND', 'MEGA_BYTES_PER_SECOND', 'GIGA_BYTES_PER_SECOND', 'TERA_BYTES_PER_SECOND', 'BITS_PER_SECOND', 'KILO_BITS_PER_SECOND', 'MEGA_BITS_PER_SECOND', 'GIGA_BITS_PER_SECOND', 'TERA_BITS_PER_SECOND', 'COUNT_PER_SECOND', ], ], 'UpdateStudioInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Description' => [ 'shape' => 'XmlStringMaxLen256', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'DefaultS3Location' => [ 'shape' => 'XmlString', ], 'EncryptionKeyArn' => [ 'shape' => 'XmlString', ], ], ], 'UpdateStudioSessionMappingInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', 'IdentityType', 'SessionPolicyArn', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'SessionPolicyArn' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'UriString' => [ 'type' => 'string', 'max' => 10280, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*', ], 'UsernamePassword' => [ 'type' => 'structure', 'members' => [ 'Username' => [ 'shape' => 'XmlStringMaxLen256', ], 'Password' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'sensitive' => true, ], 'VolumeSpecification' => [ 'type' => 'structure', 'required' => [ 'VolumeType', 'SizeInGB', ], 'members' => [ 'VolumeType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'Integer', ], 'SizeInGB' => [ 'shape' => 'Integer', ], 'Throughput' => [ 'shape' => 'ThroughputVal', ], ], ], 'WholeNumber' => [ 'type' => 'integer', 'min' => 0, ], 'XmlString' => [ 'type' => 'string', 'max' => 10280, 'min' => 0, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*', ], 'XmlStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlString', ], ], 'XmlStringMaxLen256' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*', ], 'XmlStringMaxLen256List' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2009-03-31', 'endpointPrefix' => 'elasticmapreduce', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'Amazon EMR', 'serviceFullName' => 'Amazon EMR', 'serviceId' => 'EMR', 'signatureVersion' => 'v4', 'targetPrefix' => 'ElasticMapReduce', 'uid' => 'elasticmapreduce-2009-03-31', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AddInstanceFleet' => [ 'name' => 'AddInstanceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddInstanceFleetInput', ], 'output' => [ 'shape' => 'AddInstanceFleetOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddInstanceGroups' => [ 'name' => 'AddInstanceGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddInstanceGroupsInput', ], 'output' => [ 'shape' => 'AddInstanceGroupsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'AddJobFlowSteps' => [ 'name' => 'AddJobFlowSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddJobFlowStepsInput', ], 'output' => [ 'shape' => 'AddJobFlowStepsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'AddTags' => [ 'name' => 'AddTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsInput', ], 'output' => [ 'shape' => 'AddTagsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'CancelSteps' => [ 'name' => 'CancelSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CancelStepsInput', ], 'output' => [ 'shape' => 'CancelStepsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'CreateSecurityConfiguration' => [ 'name' => 'CreateSecurityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSecurityConfigurationInput', ], 'output' => [ 'shape' => 'CreateSecurityConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'CreateStudio' => [ 'name' => 'CreateStudio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioInput', ], 'output' => [ 'shape' => 'CreateStudioOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'CreateStudioSessionMapping' => [ 'name' => 'CreateStudioSessionMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateStudioSessionMappingInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteSecurityConfiguration' => [ 'name' => 'DeleteSecurityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSecurityConfigurationInput', ], 'output' => [ 'shape' => 'DeleteSecurityConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteStudio' => [ 'name' => 'DeleteStudio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioInput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteStudioSessionMapping' => [ 'name' => 'DeleteStudioSessionMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteStudioSessionMappingInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeCluster' => [ 'name' => 'DescribeCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeClusterInput', ], 'output' => [ 'shape' => 'DescribeClusterOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeJobFlows' => [ 'name' => 'DescribeJobFlows', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeJobFlowsInput', ], 'output' => [ 'shape' => 'DescribeJobFlowsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], 'deprecated' => true, ], 'DescribeNotebookExecution' => [ 'name' => 'DescribeNotebookExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeNotebookExecutionInput', ], 'output' => [ 'shape' => 'DescribeNotebookExecutionOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeReleaseLabel' => [ 'name' => 'DescribeReleaseLabel', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReleaseLabelInput', ], 'output' => [ 'shape' => 'DescribeReleaseLabelOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeSecurityConfiguration' => [ 'name' => 'DescribeSecurityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSecurityConfigurationInput', ], 'output' => [ 'shape' => 'DescribeSecurityConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeStep' => [ 'name' => 'DescribeStep', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStepInput', ], 'output' => [ 'shape' => 'DescribeStepOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeStudio' => [ 'name' => 'DescribeStudio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeStudioInput', ], 'output' => [ 'shape' => 'DescribeStudioOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'GetAutoTerminationPolicy' => [ 'name' => 'GetAutoTerminationPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAutoTerminationPolicyInput', ], 'output' => [ 'shape' => 'GetAutoTerminationPolicyOutput', ], ], 'GetBlockPublicAccessConfiguration' => [ 'name' => 'GetBlockPublicAccessConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetBlockPublicAccessConfigurationInput', ], 'output' => [ 'shape' => 'GetBlockPublicAccessConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'GetClusterSessionCredentials' => [ 'name' => 'GetClusterSessionCredentials', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetClusterSessionCredentialsInput', ], 'output' => [ 'shape' => 'GetClusterSessionCredentialsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'GetManagedScalingPolicy' => [ 'name' => 'GetManagedScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetManagedScalingPolicyInput', ], 'output' => [ 'shape' => 'GetManagedScalingPolicyOutput', ], ], 'GetStudioSessionMapping' => [ 'name' => 'GetStudioSessionMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetStudioSessionMappingInput', ], 'output' => [ 'shape' => 'GetStudioSessionMappingOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListBootstrapActions' => [ 'name' => 'ListBootstrapActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBootstrapActionsInput', ], 'output' => [ 'shape' => 'ListBootstrapActionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListClusters' => [ 'name' => 'ListClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListClustersInput', ], 'output' => [ 'shape' => 'ListClustersOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListInstanceFleets' => [ 'name' => 'ListInstanceFleets', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInstanceFleetsInput', ], 'output' => [ 'shape' => 'ListInstanceFleetsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListInstanceGroups' => [ 'name' => 'ListInstanceGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInstanceGroupsInput', ], 'output' => [ 'shape' => 'ListInstanceGroupsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListInstances' => [ 'name' => 'ListInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInstancesInput', ], 'output' => [ 'shape' => 'ListInstancesOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListNotebookExecutions' => [ 'name' => 'ListNotebookExecutions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNotebookExecutionsInput', ], 'output' => [ 'shape' => 'ListNotebookExecutionsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListReleaseLabels' => [ 'name' => 'ListReleaseLabels', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListReleaseLabelsInput', ], 'output' => [ 'shape' => 'ListReleaseLabelsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListSecurityConfigurations' => [ 'name' => 'ListSecurityConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSecurityConfigurationsInput', ], 'output' => [ 'shape' => 'ListSecurityConfigurationsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListSteps' => [ 'name' => 'ListSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStepsInput', ], 'output' => [ 'shape' => 'ListStepsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListStudioSessionMappings' => [ 'name' => 'ListStudioSessionMappings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudioSessionMappingsInput', ], 'output' => [ 'shape' => 'ListStudioSessionMappingsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListStudios' => [ 'name' => 'ListStudios', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListStudiosInput', ], 'output' => [ 'shape' => 'ListStudiosOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ListSupportedInstanceTypes' => [ 'name' => 'ListSupportedInstanceTypes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSupportedInstanceTypesInput', ], 'output' => [ 'shape' => 'ListSupportedInstanceTypesOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ModifyCluster' => [ 'name' => 'ModifyCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyClusterInput', ], 'output' => [ 'shape' => 'ModifyClusterOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ModifyInstanceFleet' => [ 'name' => 'ModifyInstanceFleet', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyInstanceFleetInput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'ModifyInstanceGroups' => [ 'name' => 'ModifyInstanceGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyInstanceGroupsInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'PutAutoScalingPolicy' => [ 'name' => 'PutAutoScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAutoScalingPolicyInput', ], 'output' => [ 'shape' => 'PutAutoScalingPolicyOutput', ], ], 'PutAutoTerminationPolicy' => [ 'name' => 'PutAutoTerminationPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAutoTerminationPolicyInput', ], 'output' => [ 'shape' => 'PutAutoTerminationPolicyOutput', ], ], 'PutBlockPublicAccessConfiguration' => [ 'name' => 'PutBlockPublicAccessConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutBlockPublicAccessConfigurationInput', ], 'output' => [ 'shape' => 'PutBlockPublicAccessConfigurationOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'PutManagedScalingPolicy' => [ 'name' => 'PutManagedScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutManagedScalingPolicyInput', ], 'output' => [ 'shape' => 'PutManagedScalingPolicyOutput', ], ], 'RemoveAutoScalingPolicy' => [ 'name' => 'RemoveAutoScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveAutoScalingPolicyInput', ], 'output' => [ 'shape' => 'RemoveAutoScalingPolicyOutput', ], ], 'RemoveAutoTerminationPolicy' => [ 'name' => 'RemoveAutoTerminationPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveAutoTerminationPolicyInput', ], 'output' => [ 'shape' => 'RemoveAutoTerminationPolicyOutput', ], ], 'RemoveManagedScalingPolicy' => [ 'name' => 'RemoveManagedScalingPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveManagedScalingPolicyInput', ], 'output' => [ 'shape' => 'RemoveManagedScalingPolicyOutput', ], ], 'RemoveTags' => [ 'name' => 'RemoveTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsInput', ], 'output' => [ 'shape' => 'RemoveTagsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'RunJobFlow' => [ 'name' => 'RunJobFlow', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RunJobFlowInput', ], 'output' => [ 'shape' => 'RunJobFlowOutput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'SetKeepJobFlowAliveWhenNoSteps' => [ 'name' => 'SetKeepJobFlowAliveWhenNoSteps', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetKeepJobFlowAliveWhenNoStepsInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'SetTerminationProtection' => [ 'name' => 'SetTerminationProtection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetTerminationProtectionInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'SetUnhealthyNodeReplacement' => [ 'name' => 'SetUnhealthyNodeReplacement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetUnhealthyNodeReplacementInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'SetVisibleToAllUsers' => [ 'name' => 'SetVisibleToAllUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'SetVisibleToAllUsersInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'StartNotebookExecution' => [ 'name' => 'StartNotebookExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartNotebookExecutionInput', ], 'output' => [ 'shape' => 'StartNotebookExecutionOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'StopNotebookExecution' => [ 'name' => 'StopNotebookExecution', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopNotebookExecutionInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'TerminateJobFlows' => [ 'name' => 'TerminateJobFlows', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TerminateJobFlowsInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], ], ], 'UpdateStudio' => [ 'name' => 'UpdateStudio', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateStudioInput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'UpdateStudioSessionMapping' => [ 'name' => 'UpdateStudioSessionMapping', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateStudioSessionMappingInput', ], 'errors' => [ [ 'shape' => 'InternalServerError', ], [ 'shape' => 'InvalidRequestException', ], ], ], ], 'shapes' => [ 'ActionOnFailure' => [ 'type' => 'string', 'enum' => [ 'TERMINATE_JOB_FLOW', 'TERMINATE_CLUSTER', 'CANCEL_AND_WAIT', 'CONTINUE', ], ], 'AddInstanceFleetInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'InstanceFleet', ], 'members' => [ 'ClusterId' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceFleet' => [ 'shape' => 'InstanceFleetConfig', ], ], ], 'AddInstanceFleetOutput' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceFleetId' => [ 'shape' => 'InstanceFleetId', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], ], ], 'AddInstanceGroupsInput' => [ 'type' => 'structure', 'required' => [ 'InstanceGroups', 'JobFlowId', ], 'members' => [ 'InstanceGroups' => [ 'shape' => 'InstanceGroupConfigList', ], 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'AddInstanceGroupsOutput' => [ 'type' => 'structure', 'members' => [ 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceGroupIds' => [ 'shape' => 'InstanceGroupIdsList', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], ], ], 'AddJobFlowStepsInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowId', 'Steps', ], 'members' => [ 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Steps' => [ 'shape' => 'StepConfigList', ], 'ExecutionRoleArn' => [ 'shape' => 'ArnType', ], ], ], 'AddJobFlowStepsOutput' => [ 'type' => 'structure', 'members' => [ 'StepIds' => [ 'shape' => 'StepIdsList', ], ], ], 'AddTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'Tags', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AddTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'AdjustmentType' => [ 'type' => 'string', 'enum' => [ 'CHANGE_IN_CAPACITY', 'PERCENT_CHANGE_IN_CAPACITY', 'EXACT_CAPACITY', ], ], 'Application' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Version' => [ 'shape' => 'String', ], 'Args' => [ 'shape' => 'StringList', ], 'AdditionalInfo' => [ 'shape' => 'StringMap', ], ], ], 'ApplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Application', ], ], 'ArnType' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'AuthMode' => [ 'type' => 'string', 'enum' => [ 'SSO', 'IAM', ], ], 'AutoScalingPolicy' => [ 'type' => 'structure', 'required' => [ 'Constraints', 'Rules', ], 'members' => [ 'Constraints' => [ 'shape' => 'ScalingConstraints', ], 'Rules' => [ 'shape' => 'ScalingRuleList', ], ], ], 'AutoScalingPolicyDescription' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'AutoScalingPolicyStatus', ], 'Constraints' => [ 'shape' => 'ScalingConstraints', ], 'Rules' => [ 'shape' => 'ScalingRuleList', ], ], ], 'AutoScalingPolicyState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'ATTACHING', 'ATTACHED', 'DETACHING', 'DETACHED', 'FAILED', ], ], 'AutoScalingPolicyStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'AutoScalingPolicyStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'AutoScalingPolicyStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'USER_REQUEST', 'PROVISION_FAILURE', 'CLEANUP_FAILURE', ], ], 'AutoScalingPolicyStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'AutoScalingPolicyState', ], 'StateChangeReason' => [ 'shape' => 'AutoScalingPolicyStateChangeReason', ], ], ], 'AutoTerminationPolicy' => [ 'type' => 'structure', 'members' => [ 'IdleTimeout' => [ 'shape' => 'Long', ], ], ], 'BlockPublicAccessConfiguration' => [ 'type' => 'structure', 'required' => [ 'BlockPublicSecurityGroupRules', ], 'members' => [ 'BlockPublicSecurityGroupRules' => [ 'shape' => 'Boolean', ], 'PermittedPublicSecurityGroupRuleRanges' => [ 'shape' => 'PortRanges', ], ], ], 'BlockPublicAccessConfigurationMetadata' => [ 'type' => 'structure', 'required' => [ 'CreationDateTime', 'CreatedByArn', ], 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'CreatedByArn' => [ 'shape' => 'ArnType', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'BootstrapActionConfig' => [ 'type' => 'structure', 'required' => [ 'Name', 'ScriptBootstrapAction', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'ScriptBootstrapAction' => [ 'shape' => 'ScriptBootstrapActionConfig', ], ], ], 'BootstrapActionConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BootstrapActionConfig', ], ], 'BootstrapActionDetail' => [ 'type' => 'structure', 'members' => [ 'BootstrapActionConfig' => [ 'shape' => 'BootstrapActionConfig', ], ], ], 'BootstrapActionDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BootstrapActionDetail', ], ], 'CancelStepsInfo' => [ 'type' => 'structure', 'members' => [ 'StepId' => [ 'shape' => 'StepId', ], 'Status' => [ 'shape' => 'CancelStepsRequestStatus', ], 'Reason' => [ 'shape' => 'String', ], ], ], 'CancelStepsInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CancelStepsInfo', ], ], 'CancelStepsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'StepIds', ], 'members' => [ 'ClusterId' => [ 'shape' => 'XmlStringMaxLen256', ], 'StepIds' => [ 'shape' => 'StepIdsList', ], 'StepCancellationOption' => [ 'shape' => 'StepCancellationOption', ], ], ], 'CancelStepsOutput' => [ 'type' => 'structure', 'members' => [ 'CancelStepsInfoList' => [ 'shape' => 'CancelStepsInfoList', ], ], ], 'CancelStepsRequestStatus' => [ 'type' => 'string', 'enum' => [ 'SUBMITTED', 'FAILED', ], ], 'CloudWatchAlarmDefinition' => [ 'type' => 'structure', 'required' => [ 'ComparisonOperator', 'MetricName', 'Period', 'Threshold', ], 'members' => [ 'ComparisonOperator' => [ 'shape' => 'ComparisonOperator', ], 'EvaluationPeriods' => [ 'shape' => 'Integer', ], 'MetricName' => [ 'shape' => 'String', ], 'Namespace' => [ 'shape' => 'String', ], 'Period' => [ 'shape' => 'Integer', ], 'Statistic' => [ 'shape' => 'Statistic', ], 'Threshold' => [ 'shape' => 'NonNegativeDouble', ], 'Unit' => [ 'shape' => 'Unit', ], 'Dimensions' => [ 'shape' => 'MetricDimensionList', ], ], ], 'Cluster' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ClusterId', ], 'Name' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ClusterStatus', ], 'Ec2InstanceAttributes' => [ 'shape' => 'Ec2InstanceAttributes', ], 'InstanceCollectionType' => [ 'shape' => 'InstanceCollectionType', ], 'LogUri' => [ 'shape' => 'String', ], 'LogEncryptionKmsKeyId' => [ 'shape' => 'String', ], 'RequestedAmiVersion' => [ 'shape' => 'String', ], 'RunningAmiVersion' => [ 'shape' => 'String', ], 'ReleaseLabel' => [ 'shape' => 'String', ], 'AutoTerminate' => [ 'shape' => 'Boolean', ], 'TerminationProtected' => [ 'shape' => 'Boolean', ], 'UnhealthyNodeReplacement' => [ 'shape' => 'BooleanObject', ], 'VisibleToAllUsers' => [ 'shape' => 'Boolean', ], 'Applications' => [ 'shape' => 'ApplicationList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ServiceRole' => [ 'shape' => 'String', ], 'NormalizedInstanceHours' => [ 'shape' => 'Integer', ], 'MasterPublicDnsName' => [ 'shape' => 'String', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'SecurityConfiguration' => [ 'shape' => 'XmlString', ], 'AutoScalingRole' => [ 'shape' => 'XmlString', ], 'ScaleDownBehavior' => [ 'shape' => 'ScaleDownBehavior', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EbsRootVolumeSize' => [ 'shape' => 'Integer', ], 'RepoUpgradeOnBoot' => [ 'shape' => 'RepoUpgradeOnBoot', ], 'KerberosAttributes' => [ 'shape' => 'KerberosAttributes', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], 'OutpostArn' => [ 'shape' => 'OptionalArnType', ], 'StepConcurrencyLevel' => [ 'shape' => 'Integer', ], 'PlacementGroups' => [ 'shape' => 'PlacementGroupConfigList', ], 'OSReleaseLabel' => [ 'shape' => 'String', ], 'EbsRootVolumeIops' => [ 'shape' => 'Integer', ], 'EbsRootVolumeThroughput' => [ 'shape' => 'Integer', ], ], ], 'ClusterId' => [ 'type' => 'string', ], 'ClusterState' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'BOOTSTRAPPING', 'RUNNING', 'WAITING', 'TERMINATING', 'TERMINATED', 'TERMINATED_WITH_ERRORS', ], ], 'ClusterStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'ClusterStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'ClusterStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'VALIDATION_ERROR', 'INSTANCE_FAILURE', 'INSTANCE_FLEET_TIMEOUT', 'BOOTSTRAP_FAILURE', 'USER_REQUEST', 'STEP_FAILURE', 'ALL_STEPS_COMPLETED', ], ], 'ClusterStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterState', ], ], 'ClusterStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'ClusterState', ], 'StateChangeReason' => [ 'shape' => 'ClusterStateChangeReason', ], 'Timeline' => [ 'shape' => 'ClusterTimeline', ], 'ErrorDetails' => [ 'shape' => 'ErrorDetailList', ], ], ], 'ClusterSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ClusterId', ], 'Name' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'ClusterStatus', ], 'NormalizedInstanceHours' => [ 'shape' => 'Integer', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], 'OutpostArn' => [ 'shape' => 'OptionalArnType', ], ], ], 'ClusterSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ClusterSummary', ], ], 'ClusterTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'Command' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'ScriptPath' => [ 'shape' => 'String', ], 'Args' => [ 'shape' => 'StringList', ], ], ], 'CommandList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Command', ], ], 'ComparisonOperator' => [ 'type' => 'string', 'enum' => [ 'GREATER_THAN_OR_EQUAL', 'GREATER_THAN', 'LESS_THAN', 'LESS_THAN_OR_EQUAL', ], ], 'ComputeLimits' => [ 'type' => 'structure', 'required' => [ 'UnitType', 'MinimumCapacityUnits', 'MaximumCapacityUnits', ], 'members' => [ 'UnitType' => [ 'shape' => 'ComputeLimitsUnitType', ], 'MinimumCapacityUnits' => [ 'shape' => 'Integer', ], 'MaximumCapacityUnits' => [ 'shape' => 'Integer', ], 'MaximumOnDemandCapacityUnits' => [ 'shape' => 'Integer', ], 'MaximumCoreCapacityUnits' => [ 'shape' => 'Integer', ], ], ], 'ComputeLimitsUnitType' => [ 'type' => 'string', 'enum' => [ 'InstanceFleetUnits', 'Instances', 'VCPU', ], ], 'Configuration' => [ 'type' => 'structure', 'members' => [ 'Classification' => [ 'shape' => 'String', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'Properties' => [ 'shape' => 'StringMap', ], ], ], 'ConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Configuration', ], ], 'CreateSecurityConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'SecurityConfiguration', ], 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], 'SecurityConfiguration' => [ 'shape' => 'String', ], ], ], 'CreateSecurityConfigurationOutput' => [ 'type' => 'structure', 'required' => [ 'Name', 'CreationDateTime', ], 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], 'CreationDateTime' => [ 'shape' => 'Date', ], ], ], 'CreateStudioInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'AuthMode', 'VpcId', 'SubnetIds', 'ServiceRole', 'WorkspaceSecurityGroupId', 'EngineSecurityGroupId', 'DefaultS3Location', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Description' => [ 'shape' => 'XmlStringMaxLen256', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'VpcId' => [ 'shape' => 'XmlStringMaxLen256', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'UserRole' => [ 'shape' => 'XmlString', ], 'WorkspaceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EngineSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'DefaultS3Location' => [ 'shape' => 'XmlString', ], 'IdpAuthUrl' => [ 'shape' => 'XmlString', ], 'IdpRelayStateParameterName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Tags' => [ 'shape' => 'TagList', ], 'TrustedIdentityPropagationEnabled' => [ 'shape' => 'BooleanObject', ], 'IdcUserAssignment' => [ 'shape' => 'IdcUserAssignment', ], 'IdcInstanceArn' => [ 'shape' => 'ArnType', ], 'EncryptionKeyArn' => [ 'shape' => 'XmlString', ], ], ], 'CreateStudioOutput' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Url' => [ 'shape' => 'XmlString', ], ], ], 'CreateStudioSessionMappingInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', 'IdentityType', 'SessionPolicyArn', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'SessionPolicyArn' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'Credentials' => [ 'type' => 'structure', 'members' => [ 'UsernamePassword' => [ 'shape' => 'UsernamePassword', ], ], 'union' => true, ], 'Date' => [ 'type' => 'timestamp', ], 'DeleteSecurityConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], ], ], 'DeleteSecurityConfigurationOutput' => [ 'type' => 'structure', 'members' => [], ], 'DeleteStudioInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'DeleteStudioSessionMappingInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', 'IdentityType', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], ], ], 'DescribeClusterInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'DescribeClusterOutput' => [ 'type' => 'structure', 'members' => [ 'Cluster' => [ 'shape' => 'Cluster', ], ], ], 'DescribeJobFlowsInput' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Date', ], 'CreatedBefore' => [ 'shape' => 'Date', ], 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'JobFlowStates' => [ 'shape' => 'JobFlowExecutionStateList', ], ], ], 'DescribeJobFlowsOutput' => [ 'type' => 'structure', 'members' => [ 'JobFlows' => [ 'shape' => 'JobFlowDetailList', ], ], ], 'DescribeNotebookExecutionInput' => [ 'type' => 'structure', 'required' => [ 'NotebookExecutionId', ], 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'DescribeNotebookExecutionOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookExecution' => [ 'shape' => 'NotebookExecution', ], ], ], 'DescribeReleaseLabelInput' => [ 'type' => 'structure', 'members' => [ 'ReleaseLabel' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResultsNumber', ], ], ], 'DescribeReleaseLabelOutput' => [ 'type' => 'structure', 'members' => [ 'ReleaseLabel' => [ 'shape' => 'String', ], 'Applications' => [ 'shape' => 'SimplifiedApplicationList', ], 'NextToken' => [ 'shape' => 'String', ], 'AvailableOSReleases' => [ 'shape' => 'OSReleaseList', ], ], ], 'DescribeSecurityConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'Name', ], 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], ], ], 'DescribeSecurityConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], 'SecurityConfiguration' => [ 'shape' => 'String', ], 'CreationDateTime' => [ 'shape' => 'Date', ], ], ], 'DescribeStepInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'StepId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'StepId' => [ 'shape' => 'StepId', ], ], ], 'DescribeStepOutput' => [ 'type' => 'structure', 'members' => [ 'Step' => [ 'shape' => 'Step', ], ], ], 'DescribeStudioInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'DescribeStudioOutput' => [ 'type' => 'structure', 'members' => [ 'Studio' => [ 'shape' => 'Studio', ], ], ], 'EC2InstanceIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceId', ], ], 'EC2InstanceIdsToTerminateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceId', ], ], 'EbsBlockDevice' => [ 'type' => 'structure', 'members' => [ 'VolumeSpecification' => [ 'shape' => 'VolumeSpecification', ], 'Device' => [ 'shape' => 'String', ], ], ], 'EbsBlockDeviceConfig' => [ 'type' => 'structure', 'required' => [ 'VolumeSpecification', ], 'members' => [ 'VolumeSpecification' => [ 'shape' => 'VolumeSpecification', ], 'VolumesPerInstance' => [ 'shape' => 'Integer', ], ], ], 'EbsBlockDeviceConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EbsBlockDeviceConfig', ], ], 'EbsBlockDeviceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EbsBlockDevice', ], ], 'EbsConfiguration' => [ 'type' => 'structure', 'members' => [ 'EbsBlockDeviceConfigs' => [ 'shape' => 'EbsBlockDeviceConfigList', ], 'EbsOptimized' => [ 'shape' => 'BooleanObject', ], ], ], 'EbsVolume' => [ 'type' => 'structure', 'members' => [ 'Device' => [ 'shape' => 'String', ], 'VolumeId' => [ 'shape' => 'String', ], ], ], 'EbsVolumeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EbsVolume', ], ], 'Ec2InstanceAttributes' => [ 'type' => 'structure', 'members' => [ 'Ec2KeyName' => [ 'shape' => 'String', ], 'Ec2SubnetId' => [ 'shape' => 'String', ], 'RequestedEc2SubnetIds' => [ 'shape' => 'XmlStringMaxLen256List', ], 'Ec2AvailabilityZone' => [ 'shape' => 'String', ], 'RequestedEc2AvailabilityZones' => [ 'shape' => 'XmlStringMaxLen256List', ], 'IamInstanceProfile' => [ 'shape' => 'String', ], 'EmrManagedMasterSecurityGroup' => [ 'shape' => 'String', ], 'EmrManagedSlaveSecurityGroup' => [ 'shape' => 'String', ], 'ServiceAccessSecurityGroup' => [ 'shape' => 'String', ], 'AdditionalMasterSecurityGroups' => [ 'shape' => 'StringList', ], 'AdditionalSlaveSecurityGroups' => [ 'shape' => 'StringList', ], ], ], 'EnvironmentVariablesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'XmlStringMaxLen256', ], 'value' => [ 'shape' => 'XmlString', ], ], 'ErrorCode' => [ 'type' => 'string', 'max' => 256, 'min' => 1, ], 'ErrorData' => [ 'type' => 'list', 'member' => [ 'shape' => 'StringMap', ], ], 'ErrorDetail' => [ 'type' => 'structure', 'members' => [ 'ErrorCode' => [ 'shape' => 'String', ], 'ErrorData' => [ 'shape' => 'ErrorData', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'ErrorDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ErrorDetail', ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'ExecutionEngineConfig' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'XmlStringMaxLen256', ], 'Type' => [ 'shape' => 'ExecutionEngineType', ], 'MasterInstanceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'ExecutionRoleArn' => [ 'shape' => 'IAMRoleArn', ], ], ], 'ExecutionEngineType' => [ 'type' => 'string', 'enum' => [ 'EMR', ], ], 'FailureDetails' => [ 'type' => 'structure', 'members' => [ 'Reason' => [ 'shape' => 'String', ], 'Message' => [ 'shape' => 'String', ], 'LogFile' => [ 'shape' => 'String', ], ], ], 'Float' => [ 'type' => 'float', ], 'GetAutoTerminationPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'GetAutoTerminationPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'AutoTerminationPolicy' => [ 'shape' => 'AutoTerminationPolicy', ], ], ], 'GetBlockPublicAccessConfigurationInput' => [ 'type' => 'structure', 'members' => [], ], 'GetBlockPublicAccessConfigurationOutput' => [ 'type' => 'structure', 'required' => [ 'BlockPublicAccessConfiguration', 'BlockPublicAccessConfigurationMetadata', ], 'members' => [ 'BlockPublicAccessConfiguration' => [ 'shape' => 'BlockPublicAccessConfiguration', ], 'BlockPublicAccessConfigurationMetadata' => [ 'shape' => 'BlockPublicAccessConfigurationMetadata', ], ], ], 'GetClusterSessionCredentialsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'XmlStringMaxLen256', ], 'ExecutionRoleArn' => [ 'shape' => 'ArnType', ], ], ], 'GetClusterSessionCredentialsOutput' => [ 'type' => 'structure', 'members' => [ 'Credentials' => [ 'shape' => 'Credentials', ], 'ExpiresAt' => [ 'shape' => 'Date', ], ], ], 'GetManagedScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'GetManagedScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'ManagedScalingPolicy' => [ 'shape' => 'ManagedScalingPolicy', ], ], ], 'GetStudioSessionMappingInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', 'IdentityType', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], ], ], 'GetStudioSessionMappingOutput' => [ 'type' => 'structure', 'members' => [ 'SessionMapping' => [ 'shape' => 'SessionMappingDetail', ], ], ], 'HadoopJarStepConfig' => [ 'type' => 'structure', 'required' => [ 'Jar', ], 'members' => [ 'Properties' => [ 'shape' => 'KeyValueList', ], 'Jar' => [ 'shape' => 'XmlString', ], 'MainClass' => [ 'shape' => 'XmlString', ], 'Args' => [ 'shape' => 'XmlStringList', ], ], ], 'HadoopStepConfig' => [ 'type' => 'structure', 'members' => [ 'Jar' => [ 'shape' => 'String', ], 'Properties' => [ 'shape' => 'StringMap', ], 'MainClass' => [ 'shape' => 'String', ], 'Args' => [ 'shape' => 'StringList', ], ], ], 'IAMRoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => '^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$', ], 'IdcUserAssignment' => [ 'type' => 'string', 'enum' => [ 'REQUIRED', 'OPTIONAL', ], ], 'IdentityType' => [ 'type' => 'string', 'enum' => [ 'USER', 'GROUP', ], ], 'Instance' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceId', ], 'Ec2InstanceId' => [ 'shape' => 'InstanceId', ], 'PublicDnsName' => [ 'shape' => 'String', ], 'PublicIpAddress' => [ 'shape' => 'String', ], 'PrivateDnsName' => [ 'shape' => 'String', ], 'PrivateIpAddress' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'InstanceStatus', ], 'InstanceGroupId' => [ 'shape' => 'String', ], 'InstanceFleetId' => [ 'shape' => 'InstanceFleetId', ], 'Market' => [ 'shape' => 'MarketType', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'EbsVolumes' => [ 'shape' => 'EbsVolumeList', ], ], ], 'InstanceCollectionType' => [ 'type' => 'string', 'enum' => [ 'INSTANCE_FLEET', 'INSTANCE_GROUP', ], ], 'InstanceFleet' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceFleetId', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Status' => [ 'shape' => 'InstanceFleetStatus', ], 'InstanceFleetType' => [ 'shape' => 'InstanceFleetType', ], 'TargetOnDemandCapacity' => [ 'shape' => 'WholeNumber', ], 'TargetSpotCapacity' => [ 'shape' => 'WholeNumber', ], 'ProvisionedOnDemandCapacity' => [ 'shape' => 'WholeNumber', ], 'ProvisionedSpotCapacity' => [ 'shape' => 'WholeNumber', ], 'InstanceTypeSpecifications' => [ 'shape' => 'InstanceTypeSpecificationList', ], 'LaunchSpecifications' => [ 'shape' => 'InstanceFleetProvisioningSpecifications', ], 'ResizeSpecifications' => [ 'shape' => 'InstanceFleetResizingSpecifications', ], ], ], 'InstanceFleetConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceFleetType', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceFleetType' => [ 'shape' => 'InstanceFleetType', ], 'TargetOnDemandCapacity' => [ 'shape' => 'WholeNumber', ], 'TargetSpotCapacity' => [ 'shape' => 'WholeNumber', ], 'InstanceTypeConfigs' => [ 'shape' => 'InstanceTypeConfigList', ], 'LaunchSpecifications' => [ 'shape' => 'InstanceFleetProvisioningSpecifications', ], 'ResizeSpecifications' => [ 'shape' => 'InstanceFleetResizingSpecifications', ], ], ], 'InstanceFleetConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceFleetConfig', ], ], 'InstanceFleetId' => [ 'type' => 'string', ], 'InstanceFleetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceFleet', ], ], 'InstanceFleetModifyConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceFleetId', ], 'members' => [ 'InstanceFleetId' => [ 'shape' => 'InstanceFleetId', ], 'TargetOnDemandCapacity' => [ 'shape' => 'WholeNumber', ], 'TargetSpotCapacity' => [ 'shape' => 'WholeNumber', ], 'ResizeSpecifications' => [ 'shape' => 'InstanceFleetResizingSpecifications', ], ], ], 'InstanceFleetProvisioningSpecifications' => [ 'type' => 'structure', 'members' => [ 'SpotSpecification' => [ 'shape' => 'SpotProvisioningSpecification', ], 'OnDemandSpecification' => [ 'shape' => 'OnDemandProvisioningSpecification', ], ], ], 'InstanceFleetResizingSpecifications' => [ 'type' => 'structure', 'members' => [ 'SpotResizeSpecification' => [ 'shape' => 'SpotResizingSpecification', ], 'OnDemandResizeSpecification' => [ 'shape' => 'OnDemandResizingSpecification', ], ], ], 'InstanceFleetState' => [ 'type' => 'string', 'enum' => [ 'PROVISIONING', 'BOOTSTRAPPING', 'RUNNING', 'RESIZING', 'SUSPENDED', 'TERMINATING', 'TERMINATED', ], ], 'InstanceFleetStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'InstanceFleetStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'InstanceFleetStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'VALIDATION_ERROR', 'INSTANCE_FAILURE', 'CLUSTER_TERMINATED', ], ], 'InstanceFleetStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'InstanceFleetState', ], 'StateChangeReason' => [ 'shape' => 'InstanceFleetStateChangeReason', ], 'Timeline' => [ 'shape' => 'InstanceFleetTimeline', ], ], ], 'InstanceFleetTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'InstanceFleetType' => [ 'type' => 'string', 'enum' => [ 'MASTER', 'CORE', 'TASK', ], ], 'InstanceGroup' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'InstanceGroupId', ], 'Name' => [ 'shape' => 'String', ], 'Market' => [ 'shape' => 'MarketType', ], 'InstanceGroupType' => [ 'shape' => 'InstanceGroupType', ], 'BidPrice' => [ 'shape' => 'String', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'RequestedInstanceCount' => [ 'shape' => 'Integer', ], 'RunningInstanceCount' => [ 'shape' => 'Integer', ], 'Status' => [ 'shape' => 'InstanceGroupStatus', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'ConfigurationsVersion' => [ 'shape' => 'Long', ], 'LastSuccessfullyAppliedConfigurations' => [ 'shape' => 'ConfigurationList', ], 'LastSuccessfullyAppliedConfigurationsVersion' => [ 'shape' => 'Long', ], 'EbsBlockDevices' => [ 'shape' => 'EbsBlockDeviceList', ], 'EbsOptimized' => [ 'shape' => 'BooleanObject', ], 'ShrinkPolicy' => [ 'shape' => 'ShrinkPolicy', ], 'AutoScalingPolicy' => [ 'shape' => 'AutoScalingPolicyDescription', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'InstanceGroupConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceRole', 'InstanceType', 'InstanceCount', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Market' => [ 'shape' => 'MarketType', ], 'InstanceRole' => [ 'shape' => 'InstanceRoleType', ], 'BidPrice' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'EbsConfiguration' => [ 'shape' => 'EbsConfiguration', ], 'AutoScalingPolicy' => [ 'shape' => 'AutoScalingPolicy', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'InstanceGroupConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupConfig', ], ], 'InstanceGroupDetail' => [ 'type' => 'structure', 'required' => [ 'Market', 'InstanceRole', 'InstanceType', 'InstanceRequestCount', 'InstanceRunningCount', 'State', 'CreationDateTime', ], 'members' => [ 'InstanceGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Market' => [ 'shape' => 'MarketType', ], 'InstanceRole' => [ 'shape' => 'InstanceRoleType', ], 'BidPrice' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceRequestCount' => [ 'shape' => 'Integer', ], 'InstanceRunningCount' => [ 'shape' => 'Integer', ], 'State' => [ 'shape' => 'InstanceGroupState', ], 'LastStateChangeReason' => [ 'shape' => 'XmlString', ], 'CreationDateTime' => [ 'shape' => 'Date', ], 'StartDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'InstanceGroupDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupDetail', ], ], 'InstanceGroupId' => [ 'type' => 'string', ], 'InstanceGroupIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'InstanceGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroup', ], ], 'InstanceGroupModifyConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceGroupId', ], 'members' => [ 'InstanceGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'EC2InstanceIdsToTerminate' => [ 'shape' => 'EC2InstanceIdsToTerminateList', ], 'ShrinkPolicy' => [ 'shape' => 'ShrinkPolicy', ], 'ReconfigurationType' => [ 'shape' => 'ReconfigurationType', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], ], ], 'InstanceGroupModifyConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupModifyConfig', ], ], 'InstanceGroupState' => [ 'type' => 'string', 'enum' => [ 'PROVISIONING', 'BOOTSTRAPPING', 'RUNNING', 'RECONFIGURING', 'RESIZING', 'SUSPENDED', 'TERMINATING', 'TERMINATED', 'ARRESTED', 'SHUTTING_DOWN', 'ENDED', ], ], 'InstanceGroupStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'InstanceGroupStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'InstanceGroupStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'VALIDATION_ERROR', 'INSTANCE_FAILURE', 'CLUSTER_TERMINATED', ], ], 'InstanceGroupStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'InstanceGroupState', ], 'StateChangeReason' => [ 'shape' => 'InstanceGroupStateChangeReason', ], 'Timeline' => [ 'shape' => 'InstanceGroupTimeline', ], ], ], 'InstanceGroupTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'InstanceGroupType' => [ 'type' => 'string', 'enum' => [ 'MASTER', 'CORE', 'TASK', ], ], 'InstanceGroupTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceGroupType', ], ], 'InstanceId' => [ 'type' => 'string', ], 'InstanceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Instance', ], ], 'InstanceResizePolicy' => [ 'type' => 'structure', 'members' => [ 'InstancesToTerminate' => [ 'shape' => 'EC2InstanceIdsList', ], 'InstancesToProtect' => [ 'shape' => 'EC2InstanceIdsList', ], 'InstanceTerminationTimeout' => [ 'shape' => 'Integer', ], ], ], 'InstanceRoleType' => [ 'type' => 'string', 'enum' => [ 'MASTER', 'CORE', 'TASK', ], ], 'InstanceState' => [ 'type' => 'string', 'enum' => [ 'AWAITING_FULFILLMENT', 'PROVISIONING', 'BOOTSTRAPPING', 'RUNNING', 'TERMINATED', ], ], 'InstanceStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'InstanceStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'InstanceStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'INTERNAL_ERROR', 'VALIDATION_ERROR', 'INSTANCE_FAILURE', 'BOOTSTRAP_FAILURE', 'CLUSTER_TERMINATED', ], ], 'InstanceStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceState', ], ], 'InstanceStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'InstanceState', ], 'StateChangeReason' => [ 'shape' => 'InstanceStateChangeReason', ], 'Timeline' => [ 'shape' => 'InstanceTimeline', ], ], ], 'InstanceTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'InstanceType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*', ], 'InstanceTypeConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceType', ], 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'WeightedCapacity' => [ 'shape' => 'WholeNumber', ], 'BidPrice' => [ 'shape' => 'XmlStringMaxLen256', ], 'BidPriceAsPercentageOfOnDemandPrice' => [ 'shape' => 'NonNegativeDouble', ], 'EbsConfiguration' => [ 'shape' => 'EbsConfiguration', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Priority' => [ 'shape' => 'NonNegativeDouble', ], ], ], 'InstanceTypeConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceTypeConfig', ], ], 'InstanceTypeSpecification' => [ 'type' => 'structure', 'members' => [ 'InstanceType' => [ 'shape' => 'InstanceType', ], 'WeightedCapacity' => [ 'shape' => 'WholeNumber', ], 'BidPrice' => [ 'shape' => 'XmlStringMaxLen256', ], 'BidPriceAsPercentageOfOnDemandPrice' => [ 'shape' => 'NonNegativeDouble', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'EbsBlockDevices' => [ 'shape' => 'EbsBlockDeviceList', ], 'EbsOptimized' => [ 'shape' => 'BooleanObject', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Priority' => [ 'shape' => 'NonNegativeDouble', ], ], ], 'InstanceTypeSpecificationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceTypeSpecification', ], ], 'Integer' => [ 'type' => 'integer', ], 'InternalServerError' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, 'fault' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'ErrorCode' => [ 'shape' => 'ErrorCode', ], 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'JobFlowDetail' => [ 'type' => 'structure', 'required' => [ 'JobFlowId', 'Name', 'ExecutionStatusDetail', 'Instances', ], 'members' => [ 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'LogUri' => [ 'shape' => 'XmlString', ], 'LogEncryptionKmsKeyId' => [ 'shape' => 'XmlString', ], 'AmiVersion' => [ 'shape' => 'XmlStringMaxLen256', ], 'ExecutionStatusDetail' => [ 'shape' => 'JobFlowExecutionStatusDetail', ], 'Instances' => [ 'shape' => 'JobFlowInstancesDetail', ], 'Steps' => [ 'shape' => 'StepDetailList', ], 'BootstrapActions' => [ 'shape' => 'BootstrapActionDetailList', ], 'SupportedProducts' => [ 'shape' => 'SupportedProductsList', ], 'VisibleToAllUsers' => [ 'shape' => 'Boolean', ], 'JobFlowRole' => [ 'shape' => 'XmlString', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'AutoScalingRole' => [ 'shape' => 'XmlString', ], 'ScaleDownBehavior' => [ 'shape' => 'ScaleDownBehavior', ], ], ], 'JobFlowDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'JobFlowDetail', ], ], 'JobFlowExecutionState' => [ 'type' => 'string', 'enum' => [ 'STARTING', 'BOOTSTRAPPING', 'RUNNING', 'WAITING', 'SHUTTING_DOWN', 'TERMINATED', 'COMPLETED', 'FAILED', ], ], 'JobFlowExecutionStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'JobFlowExecutionState', ], ], 'JobFlowExecutionStatusDetail' => [ 'type' => 'structure', 'required' => [ 'State', 'CreationDateTime', ], 'members' => [ 'State' => [ 'shape' => 'JobFlowExecutionState', ], 'CreationDateTime' => [ 'shape' => 'Date', ], 'StartDateTime' => [ 'shape' => 'Date', ], 'ReadyDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], 'LastStateChangeReason' => [ 'shape' => 'XmlString', ], ], ], 'JobFlowInstancesConfig' => [ 'type' => 'structure', 'members' => [ 'MasterInstanceType' => [ 'shape' => 'InstanceType', ], 'SlaveInstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroupConfigList', ], 'InstanceFleets' => [ 'shape' => 'InstanceFleetConfigList', ], 'Ec2KeyName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Placement' => [ 'shape' => 'PlacementType', ], 'KeepJobFlowAliveWhenNoSteps' => [ 'shape' => 'Boolean', ], 'TerminationProtected' => [ 'shape' => 'Boolean', ], 'UnhealthyNodeReplacement' => [ 'shape' => 'BooleanObject', ], 'HadoopVersion' => [ 'shape' => 'XmlStringMaxLen256', ], 'Ec2SubnetId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Ec2SubnetIds' => [ 'shape' => 'XmlStringMaxLen256List', ], 'EmrManagedMasterSecurityGroup' => [ 'shape' => 'XmlStringMaxLen256', ], 'EmrManagedSlaveSecurityGroup' => [ 'shape' => 'XmlStringMaxLen256', ], 'ServiceAccessSecurityGroup' => [ 'shape' => 'XmlStringMaxLen256', ], 'AdditionalMasterSecurityGroups' => [ 'shape' => 'SecurityGroupsList', ], 'AdditionalSlaveSecurityGroups' => [ 'shape' => 'SecurityGroupsList', ], ], ], 'JobFlowInstancesDetail' => [ 'type' => 'structure', 'required' => [ 'MasterInstanceType', 'SlaveInstanceType', 'InstanceCount', ], 'members' => [ 'MasterInstanceType' => [ 'shape' => 'InstanceType', ], 'MasterPublicDnsName' => [ 'shape' => 'XmlString', ], 'MasterInstanceId' => [ 'shape' => 'XmlString', ], 'SlaveInstanceType' => [ 'shape' => 'InstanceType', ], 'InstanceCount' => [ 'shape' => 'Integer', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroupDetailList', ], 'NormalizedInstanceHours' => [ 'shape' => 'Integer', ], 'Ec2KeyName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Ec2SubnetId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Placement' => [ 'shape' => 'PlacementType', ], 'KeepJobFlowAliveWhenNoSteps' => [ 'shape' => 'Boolean', ], 'TerminationProtected' => [ 'shape' => 'Boolean', ], 'UnhealthyNodeReplacement' => [ 'shape' => 'BooleanObject', ], 'HadoopVersion' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'KerberosAttributes' => [ 'type' => 'structure', 'required' => [ 'Realm', 'KdcAdminPassword', ], 'members' => [ 'Realm' => [ 'shape' => 'XmlStringMaxLen256', ], 'KdcAdminPassword' => [ 'shape' => 'XmlStringMaxLen256', ], 'CrossRealmTrustPrincipalPassword' => [ 'shape' => 'XmlStringMaxLen256', ], 'ADDomainJoinUser' => [ 'shape' => 'XmlStringMaxLen256', ], 'ADDomainJoinPassword' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'KeyValue' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'XmlString', ], 'Value' => [ 'shape' => 'XmlString', ], ], ], 'KeyValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'KeyValue', ], ], 'ListBootstrapActionsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListBootstrapActionsOutput' => [ 'type' => 'structure', 'members' => [ 'BootstrapActions' => [ 'shape' => 'CommandList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListClustersInput' => [ 'type' => 'structure', 'members' => [ 'CreatedAfter' => [ 'shape' => 'Date', ], 'CreatedBefore' => [ 'shape' => 'Date', ], 'ClusterStates' => [ 'shape' => 'ClusterStateList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListClustersOutput' => [ 'type' => 'structure', 'members' => [ 'Clusters' => [ 'shape' => 'ClusterSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstanceFleetsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstanceFleetsOutput' => [ 'type' => 'structure', 'members' => [ 'InstanceFleets' => [ 'shape' => 'InstanceFleetList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstanceGroupsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstanceGroupsOutput' => [ 'type' => 'structure', 'members' => [ 'InstanceGroups' => [ 'shape' => 'InstanceGroupList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstancesInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroupId' => [ 'shape' => 'InstanceGroupId', ], 'InstanceGroupTypes' => [ 'shape' => 'InstanceGroupTypeList', ], 'InstanceFleetId' => [ 'shape' => 'InstanceFleetId', ], 'InstanceFleetType' => [ 'shape' => 'InstanceFleetType', ], 'InstanceStates' => [ 'shape' => 'InstanceStateList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListInstancesOutput' => [ 'type' => 'structure', 'members' => [ 'Instances' => [ 'shape' => 'InstanceList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListNotebookExecutionsInput' => [ 'type' => 'structure', 'members' => [ 'EditorId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Status' => [ 'shape' => 'NotebookExecutionStatus', ], 'From' => [ 'shape' => 'Date', ], 'To' => [ 'shape' => 'Date', ], 'Marker' => [ 'shape' => 'Marker', ], 'ExecutionEngineId' => [ 'shape' => 'XmlString', ], ], ], 'ListNotebookExecutionsOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookExecutions' => [ 'shape' => 'NotebookExecutionSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListReleaseLabelsInput' => [ 'type' => 'structure', 'members' => [ 'Filters' => [ 'shape' => 'ReleaseLabelFilter', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'MaxResultsNumber', ], ], ], 'ListReleaseLabelsOutput' => [ 'type' => 'structure', 'members' => [ 'ReleaseLabels' => [ 'shape' => 'StringList', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'ListSecurityConfigurationsInput' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListSecurityConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'SecurityConfigurations' => [ 'shape' => 'SecurityConfigurationList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStepsInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'StepStates' => [ 'shape' => 'StepStateList', ], 'StepIds' => [ 'shape' => 'XmlStringList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStepsOutput' => [ 'type' => 'structure', 'members' => [ 'Steps' => [ 'shape' => 'StepSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStudioSessionMappingsInput' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStudioSessionMappingsOutput' => [ 'type' => 'structure', 'members' => [ 'SessionMappings' => [ 'shape' => 'SessionMappingSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStudiosInput' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListStudiosOutput' => [ 'type' => 'structure', 'members' => [ 'Studios' => [ 'shape' => 'StudioSummaryList', ], 'Marker' => [ 'shape' => 'Marker', ], ], ], 'ListSupportedInstanceTypesInput' => [ 'type' => 'structure', 'required' => [ 'ReleaseLabel', ], 'members' => [ 'ReleaseLabel' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'ListSupportedInstanceTypesOutput' => [ 'type' => 'structure', 'members' => [ 'SupportedInstanceTypes' => [ 'shape' => 'SupportedInstanceTypesList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'Long' => [ 'type' => 'long', ], 'ManagedScalingPolicy' => [ 'type' => 'structure', 'members' => [ 'ComputeLimits' => [ 'shape' => 'ComputeLimits', ], ], ], 'Marker' => [ 'type' => 'string', ], 'MarketType' => [ 'type' => 'string', 'enum' => [ 'ON_DEMAND', 'SPOT', ], ], 'MaxResultsNumber' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'MetricDimension' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'MetricDimensionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricDimension', ], ], 'ModifyClusterInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'String', ], 'StepConcurrencyLevel' => [ 'shape' => 'Integer', ], ], ], 'ModifyClusterOutput' => [ 'type' => 'structure', 'members' => [ 'StepConcurrencyLevel' => [ 'shape' => 'Integer', ], ], ], 'ModifyInstanceFleetInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'InstanceFleet', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceFleet' => [ 'shape' => 'InstanceFleetModifyConfig', ], ], ], 'ModifyInstanceGroupsInput' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroups' => [ 'shape' => 'InstanceGroupModifyConfigList', ], ], ], 'NewSupportedProductsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SupportedProductConfig', ], ], 'NonNegativeDouble' => [ 'type' => 'double', 'min' => 0.0, ], 'NotebookExecution' => [ 'type' => 'structure', 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EditorId' => [ 'shape' => 'XmlStringMaxLen256', ], 'ExecutionEngine' => [ 'shape' => 'ExecutionEngineConfig', ], 'NotebookExecutionName' => [ 'shape' => 'XmlStringMaxLen256', ], 'NotebookParams' => [ 'shape' => 'XmlString', ], 'Status' => [ 'shape' => 'NotebookExecutionStatus', ], 'StartTime' => [ 'shape' => 'Date', ], 'EndTime' => [ 'shape' => 'Date', ], 'Arn' => [ 'shape' => 'XmlStringMaxLen256', ], 'OutputNotebookURI' => [ 'shape' => 'XmlString', ], 'LastStateChangeReason' => [ 'shape' => 'XmlString', ], 'NotebookInstanceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Tags' => [ 'shape' => 'TagList', ], 'NotebookS3Location' => [ 'shape' => 'NotebookS3LocationForOutput', ], 'OutputNotebookS3Location' => [ 'shape' => 'OutputNotebookS3LocationForOutput', ], 'OutputNotebookFormat' => [ 'shape' => 'OutputNotebookFormat', ], 'EnvironmentVariables' => [ 'shape' => 'EnvironmentVariablesMap', ], ], ], 'NotebookExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'START_PENDING', 'STARTING', 'RUNNING', 'FINISHING', 'FINISHED', 'FAILING', 'FAILED', 'STOP_PENDING', 'STOPPING', 'STOPPED', ], ], 'NotebookExecutionSummary' => [ 'type' => 'structure', 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EditorId' => [ 'shape' => 'XmlStringMaxLen256', ], 'NotebookExecutionName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Status' => [ 'shape' => 'NotebookExecutionStatus', ], 'StartTime' => [ 'shape' => 'Date', ], 'EndTime' => [ 'shape' => 'Date', ], 'NotebookS3Location' => [ 'shape' => 'NotebookS3LocationForOutput', ], 'ExecutionEngineId' => [ 'shape' => 'XmlString', ], ], ], 'NotebookExecutionSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NotebookExecutionSummary', ], ], 'NotebookS3LocationForOutput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'XmlStringMaxLen256', ], 'Key' => [ 'shape' => 'UriString', ], ], ], 'NotebookS3LocationFromInput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'XmlStringMaxLen256', ], 'Key' => [ 'shape' => 'UriString', ], ], ], 'OSRelease' => [ 'type' => 'structure', 'members' => [ 'Label' => [ 'shape' => 'String', ], ], ], 'OSReleaseList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OSRelease', ], ], 'OnDemandCapacityReservationOptions' => [ 'type' => 'structure', 'members' => [ 'UsageStrategy' => [ 'shape' => 'OnDemandCapacityReservationUsageStrategy', ], 'CapacityReservationPreference' => [ 'shape' => 'OnDemandCapacityReservationPreference', ], 'CapacityReservationResourceGroupArn' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'OnDemandCapacityReservationPreference' => [ 'type' => 'string', 'enum' => [ 'open', 'none', ], ], 'OnDemandCapacityReservationUsageStrategy' => [ 'type' => 'string', 'enum' => [ 'use-capacity-reservations-first', ], ], 'OnDemandProvisioningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'lowest-price', 'prioritized', ], ], 'OnDemandProvisioningSpecification' => [ 'type' => 'structure', 'required' => [ 'AllocationStrategy', ], 'members' => [ 'AllocationStrategy' => [ 'shape' => 'OnDemandProvisioningAllocationStrategy', ], 'CapacityReservationOptions' => [ 'shape' => 'OnDemandCapacityReservationOptions', ], ], ], 'OnDemandResizingSpecification' => [ 'type' => 'structure', 'required' => [ 'TimeoutDurationMinutes', ], 'members' => [ 'TimeoutDurationMinutes' => [ 'shape' => 'WholeNumber', ], ], ], 'OptionalArnType' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'OutputNotebookFormat' => [ 'type' => 'string', 'enum' => [ 'HTML', ], ], 'OutputNotebookS3LocationForOutput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'XmlStringMaxLen256', ], 'Key' => [ 'shape' => 'UriString', ], ], ], 'OutputNotebookS3LocationFromInput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'XmlStringMaxLen256', ], 'Key' => [ 'shape' => 'UriString', ], ], ], 'PlacementGroupConfig' => [ 'type' => 'structure', 'required' => [ 'InstanceRole', ], 'members' => [ 'InstanceRole' => [ 'shape' => 'InstanceRoleType', ], 'PlacementStrategy' => [ 'shape' => 'PlacementGroupStrategy', ], ], ], 'PlacementGroupConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PlacementGroupConfig', ], ], 'PlacementGroupStrategy' => [ 'type' => 'string', 'enum' => [ 'SPREAD', 'PARTITION', 'CLUSTER', 'NONE', ], ], 'PlacementType' => [ 'type' => 'structure', 'members' => [ 'AvailabilityZone' => [ 'shape' => 'XmlString', ], 'AvailabilityZones' => [ 'shape' => 'XmlStringMaxLen256List', ], ], ], 'Port' => [ 'type' => 'integer', 'max' => 65535, 'min' => -1, ], 'PortRange' => [ 'type' => 'structure', 'required' => [ 'MinRange', ], 'members' => [ 'MinRange' => [ 'shape' => 'Port', ], 'MaxRange' => [ 'shape' => 'Port', ], ], ], 'PortRanges' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortRange', ], ], 'PutAutoScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'InstanceGroupId', 'AutoScalingPolicy', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroupId' => [ 'shape' => 'InstanceGroupId', ], 'AutoScalingPolicy' => [ 'shape' => 'AutoScalingPolicy', ], ], ], 'PutAutoScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroupId' => [ 'shape' => 'InstanceGroupId', ], 'AutoScalingPolicy' => [ 'shape' => 'AutoScalingPolicyDescription', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], ], ], 'PutAutoTerminationPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'AutoTerminationPolicy' => [ 'shape' => 'AutoTerminationPolicy', ], ], ], 'PutAutoTerminationPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'PutBlockPublicAccessConfigurationInput' => [ 'type' => 'structure', 'required' => [ 'BlockPublicAccessConfiguration', ], 'members' => [ 'BlockPublicAccessConfiguration' => [ 'shape' => 'BlockPublicAccessConfiguration', ], ], ], 'PutBlockPublicAccessConfigurationOutput' => [ 'type' => 'structure', 'members' => [], ], 'PutManagedScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'ManagedScalingPolicy', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'ManagedScalingPolicy' => [ 'shape' => 'ManagedScalingPolicy', ], ], ], 'PutManagedScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'ReconfigurationType' => [ 'type' => 'string', 'enum' => [ 'OVERWRITE', 'MERGE', ], ], 'ReleaseLabelFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'String', ], 'Application' => [ 'shape' => 'String', ], ], ], 'RemoveAutoScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', 'InstanceGroupId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], 'InstanceGroupId' => [ 'shape' => 'InstanceGroupId', ], ], ], 'RemoveAutoScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'RemoveAutoTerminationPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'RemoveAutoTerminationPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'RemoveManagedScalingPolicyInput' => [ 'type' => 'structure', 'required' => [ 'ClusterId', ], 'members' => [ 'ClusterId' => [ 'shape' => 'ClusterId', ], ], ], 'RemoveManagedScalingPolicyOutput' => [ 'type' => 'structure', 'members' => [], ], 'RemoveTagsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceId', 'TagKeys', ], 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'TagKeys' => [ 'shape' => 'StringList', ], ], ], 'RemoveTagsOutput' => [ 'type' => 'structure', 'members' => [], ], 'RepoUpgradeOnBoot' => [ 'type' => 'string', 'enum' => [ 'SECURITY', 'NONE', ], ], 'ResourceId' => [ 'type' => 'string', ], 'RunJobFlowInput' => [ 'type' => 'structure', 'required' => [ 'Name', 'Instances', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'LogUri' => [ 'shape' => 'XmlString', ], 'LogEncryptionKmsKeyId' => [ 'shape' => 'XmlString', ], 'AdditionalInfo' => [ 'shape' => 'XmlString', ], 'AmiVersion' => [ 'shape' => 'XmlStringMaxLen256', ], 'ReleaseLabel' => [ 'shape' => 'XmlStringMaxLen256', ], 'Instances' => [ 'shape' => 'JobFlowInstancesConfig', ], 'Steps' => [ 'shape' => 'StepConfigList', ], 'BootstrapActions' => [ 'shape' => 'BootstrapActionConfigList', ], 'SupportedProducts' => [ 'shape' => 'SupportedProductsList', ], 'NewSupportedProducts' => [ 'shape' => 'NewSupportedProductsList', ], 'Applications' => [ 'shape' => 'ApplicationList', ], 'Configurations' => [ 'shape' => 'ConfigurationList', ], 'VisibleToAllUsers' => [ 'shape' => 'Boolean', ], 'JobFlowRole' => [ 'shape' => 'XmlString', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'Tags' => [ 'shape' => 'TagList', ], 'SecurityConfiguration' => [ 'shape' => 'XmlString', ], 'AutoScalingRole' => [ 'shape' => 'XmlString', ], 'ScaleDownBehavior' => [ 'shape' => 'ScaleDownBehavior', ], 'CustomAmiId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EbsRootVolumeSize' => [ 'shape' => 'Integer', ], 'RepoUpgradeOnBoot' => [ 'shape' => 'RepoUpgradeOnBoot', ], 'KerberosAttributes' => [ 'shape' => 'KerberosAttributes', ], 'StepConcurrencyLevel' => [ 'shape' => 'Integer', ], 'ManagedScalingPolicy' => [ 'shape' => 'ManagedScalingPolicy', ], 'PlacementGroupConfigs' => [ 'shape' => 'PlacementGroupConfigList', ], 'AutoTerminationPolicy' => [ 'shape' => 'AutoTerminationPolicy', ], 'OSReleaseLabel' => [ 'shape' => 'XmlStringMaxLen256', ], 'EbsRootVolumeIops' => [ 'shape' => 'Integer', ], 'EbsRootVolumeThroughput' => [ 'shape' => 'Integer', ], ], ], 'RunJobFlowOutput' => [ 'type' => 'structure', 'members' => [ 'JobFlowId' => [ 'shape' => 'XmlStringMaxLen256', ], 'ClusterArn' => [ 'shape' => 'ArnType', ], ], ], 'ScaleDownBehavior' => [ 'type' => 'string', 'enum' => [ 'TERMINATE_AT_INSTANCE_HOUR', 'TERMINATE_AT_TASK_COMPLETION', ], ], 'ScalingAction' => [ 'type' => 'structure', 'required' => [ 'SimpleScalingPolicyConfiguration', ], 'members' => [ 'Market' => [ 'shape' => 'MarketType', ], 'SimpleScalingPolicyConfiguration' => [ 'shape' => 'SimpleScalingPolicyConfiguration', ], ], ], 'ScalingConstraints' => [ 'type' => 'structure', 'required' => [ 'MinCapacity', 'MaxCapacity', ], 'members' => [ 'MinCapacity' => [ 'shape' => 'Integer', ], 'MaxCapacity' => [ 'shape' => 'Integer', ], ], ], 'ScalingRule' => [ 'type' => 'structure', 'required' => [ 'Name', 'Action', 'Trigger', ], 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Action' => [ 'shape' => 'ScalingAction', ], 'Trigger' => [ 'shape' => 'ScalingTrigger', ], ], ], 'ScalingRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScalingRule', ], ], 'ScalingTrigger' => [ 'type' => 'structure', 'required' => [ 'CloudWatchAlarmDefinition', ], 'members' => [ 'CloudWatchAlarmDefinition' => [ 'shape' => 'CloudWatchAlarmDefinition', ], ], ], 'ScriptBootstrapActionConfig' => [ 'type' => 'structure', 'required' => [ 'Path', ], 'members' => [ 'Path' => [ 'shape' => 'XmlString', ], 'Args' => [ 'shape' => 'XmlStringList', ], ], ], 'SecurityConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityConfigurationSummary', ], ], 'SecurityConfigurationSummary' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'XmlString', ], 'CreationDateTime' => [ 'shape' => 'Date', ], ], ], 'SecurityGroupsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'SessionMappingDetail' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'SessionPolicyArn' => [ 'shape' => 'XmlStringMaxLen256', ], 'CreationTime' => [ 'shape' => 'Date', ], 'LastModifiedTime' => [ 'shape' => 'Date', ], ], ], 'SessionMappingSummary' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'SessionPolicyArn' => [ 'shape' => 'XmlStringMaxLen256', ], 'CreationTime' => [ 'shape' => 'Date', ], ], ], 'SessionMappingSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SessionMappingSummary', ], ], 'SetKeepJobFlowAliveWhenNoStepsInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', 'KeepJobFlowAliveWhenNoSteps', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'KeepJobFlowAliveWhenNoSteps' => [ 'shape' => 'Boolean', ], ], ], 'SetTerminationProtectionInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', 'TerminationProtected', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'TerminationProtected' => [ 'shape' => 'Boolean', ], ], ], 'SetUnhealthyNodeReplacementInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', 'UnhealthyNodeReplacement', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'UnhealthyNodeReplacement' => [ 'shape' => 'BooleanObject', ], ], ], 'SetVisibleToAllUsersInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', 'VisibleToAllUsers', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], 'VisibleToAllUsers' => [ 'shape' => 'Boolean', ], ], ], 'ShrinkPolicy' => [ 'type' => 'structure', 'members' => [ 'DecommissionTimeout' => [ 'shape' => 'Integer', ], 'InstanceResizePolicy' => [ 'shape' => 'InstanceResizePolicy', ], ], ], 'SimpleScalingPolicyConfiguration' => [ 'type' => 'structure', 'required' => [ 'ScalingAdjustment', ], 'members' => [ 'AdjustmentType' => [ 'shape' => 'AdjustmentType', ], 'ScalingAdjustment' => [ 'shape' => 'Integer', ], 'CoolDown' => [ 'shape' => 'Integer', ], ], ], 'SimplifiedApplication' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], 'Version' => [ 'shape' => 'String', ], ], ], 'SimplifiedApplicationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SimplifiedApplication', ], ], 'SpotProvisioningAllocationStrategy' => [ 'type' => 'string', 'enum' => [ 'capacity-optimized', 'price-capacity-optimized', 'lowest-price', 'diversified', 'capacity-optimized-prioritized', ], ], 'SpotProvisioningSpecification' => [ 'type' => 'structure', 'required' => [ 'TimeoutDurationMinutes', 'TimeoutAction', ], 'members' => [ 'TimeoutDurationMinutes' => [ 'shape' => 'WholeNumber', ], 'TimeoutAction' => [ 'shape' => 'SpotProvisioningTimeoutAction', ], 'BlockDurationMinutes' => [ 'shape' => 'WholeNumber', ], 'AllocationStrategy' => [ 'shape' => 'SpotProvisioningAllocationStrategy', ], ], ], 'SpotProvisioningTimeoutAction' => [ 'type' => 'string', 'enum' => [ 'SWITCH_TO_ON_DEMAND', 'TERMINATE_CLUSTER', ], ], 'SpotResizingSpecification' => [ 'type' => 'structure', 'required' => [ 'TimeoutDurationMinutes', ], 'members' => [ 'TimeoutDurationMinutes' => [ 'shape' => 'WholeNumber', ], ], ], 'StartNotebookExecutionInput' => [ 'type' => 'structure', 'required' => [ 'ExecutionEngine', 'ServiceRole', ], 'members' => [ 'EditorId' => [ 'shape' => 'XmlStringMaxLen256', ], 'RelativePath' => [ 'shape' => 'XmlString', ], 'NotebookExecutionName' => [ 'shape' => 'XmlStringMaxLen256', ], 'NotebookParams' => [ 'shape' => 'XmlString', ], 'ExecutionEngine' => [ 'shape' => 'ExecutionEngineConfig', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'NotebookInstanceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Tags' => [ 'shape' => 'TagList', ], 'NotebookS3Location' => [ 'shape' => 'NotebookS3LocationFromInput', ], 'OutputNotebookS3Location' => [ 'shape' => 'OutputNotebookS3LocationFromInput', ], 'OutputNotebookFormat' => [ 'shape' => 'OutputNotebookFormat', ], 'EnvironmentVariables' => [ 'shape' => 'EnvironmentVariablesMap', ], ], ], 'StartNotebookExecutionOutput' => [ 'type' => 'structure', 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'Statistic' => [ 'type' => 'string', 'enum' => [ 'SAMPLE_COUNT', 'AVERAGE', 'SUM', 'MINIMUM', 'MAXIMUM', ], ], 'Step' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'StepId', ], 'Name' => [ 'shape' => 'String', ], 'Config' => [ 'shape' => 'HadoopStepConfig', ], 'ActionOnFailure' => [ 'shape' => 'ActionOnFailure', ], 'Status' => [ 'shape' => 'StepStatus', ], 'ExecutionRoleArn' => [ 'shape' => 'OptionalArnType', ], ], ], 'StepCancellationOption' => [ 'type' => 'string', 'enum' => [ 'SEND_INTERRUPT', 'TERMINATE_PROCESS', ], ], 'StepConfig' => [ 'type' => 'structure', 'required' => [ 'Name', 'HadoopJarStep', ], 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'ActionOnFailure' => [ 'shape' => 'ActionOnFailure', ], 'HadoopJarStep' => [ 'shape' => 'HadoopJarStepConfig', ], ], ], 'StepConfigList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StepConfig', ], ], 'StepDetail' => [ 'type' => 'structure', 'required' => [ 'StepConfig', 'ExecutionStatusDetail', ], 'members' => [ 'StepConfig' => [ 'shape' => 'StepConfig', ], 'ExecutionStatusDetail' => [ 'shape' => 'StepExecutionStatusDetail', ], ], ], 'StepDetailList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StepDetail', ], ], 'StepExecutionState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'RUNNING', 'CONTINUE', 'COMPLETED', 'CANCELLED', 'FAILED', 'INTERRUPTED', ], ], 'StepExecutionStatusDetail' => [ 'type' => 'structure', 'required' => [ 'State', 'CreationDateTime', ], 'members' => [ 'State' => [ 'shape' => 'StepExecutionState', ], 'CreationDateTime' => [ 'shape' => 'Date', ], 'StartDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], 'LastStateChangeReason' => [ 'shape' => 'XmlString', ], ], ], 'StepId' => [ 'type' => 'string', ], 'StepIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'StepState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'CANCEL_PENDING', 'RUNNING', 'COMPLETED', 'CANCELLED', 'FAILED', 'INTERRUPTED', ], ], 'StepStateChangeReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'StepStateChangeReasonCode', ], 'Message' => [ 'shape' => 'String', ], ], ], 'StepStateChangeReasonCode' => [ 'type' => 'string', 'enum' => [ 'NONE', ], ], 'StepStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StepState', ], ], 'StepStatus' => [ 'type' => 'structure', 'members' => [ 'State' => [ 'shape' => 'StepState', ], 'StateChangeReason' => [ 'shape' => 'StepStateChangeReason', ], 'FailureDetails' => [ 'shape' => 'FailureDetails', ], 'Timeline' => [ 'shape' => 'StepTimeline', ], ], ], 'StepSummary' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'StepId', ], 'Name' => [ 'shape' => 'String', ], 'Config' => [ 'shape' => 'HadoopStepConfig', ], 'ActionOnFailure' => [ 'shape' => 'ActionOnFailure', ], 'Status' => [ 'shape' => 'StepStatus', ], ], ], 'StepSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StepSummary', ], ], 'StepTimeline' => [ 'type' => 'structure', 'members' => [ 'CreationDateTime' => [ 'shape' => 'Date', ], 'StartDateTime' => [ 'shape' => 'Date', ], 'EndDateTime' => [ 'shape' => 'Date', ], ], ], 'StopNotebookExecutionInput' => [ 'type' => 'structure', 'required' => [ 'NotebookExecutionId', ], 'members' => [ 'NotebookExecutionId' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'String' => [ 'type' => 'string', ], 'StringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'StringMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'Studio' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'StudioArn' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Description' => [ 'shape' => 'XmlStringMaxLen256', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'VpcId' => [ 'shape' => 'XmlStringMaxLen256', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'ServiceRole' => [ 'shape' => 'XmlString', ], 'UserRole' => [ 'shape' => 'XmlString', ], 'WorkspaceSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'EngineSecurityGroupId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Url' => [ 'shape' => 'XmlString', ], 'CreationTime' => [ 'shape' => 'Date', ], 'DefaultS3Location' => [ 'shape' => 'XmlString', ], 'IdpAuthUrl' => [ 'shape' => 'XmlString', ], 'IdpRelayStateParameterName' => [ 'shape' => 'XmlStringMaxLen256', ], 'Tags' => [ 'shape' => 'TagList', ], 'IdcInstanceArn' => [ 'shape' => 'ArnType', ], 'TrustedIdentityPropagationEnabled' => [ 'shape' => 'BooleanObject', ], 'IdcUserAssignment' => [ 'shape' => 'IdcUserAssignment', ], 'EncryptionKeyArn' => [ 'shape' => 'XmlString', ], ], ], 'StudioSummary' => [ 'type' => 'structure', 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'VpcId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Description' => [ 'shape' => 'XmlStringMaxLen256', ], 'Url' => [ 'shape' => 'XmlStringMaxLen256', ], 'AuthMode' => [ 'shape' => 'AuthMode', ], 'CreationTime' => [ 'shape' => 'Date', ], ], ], 'StudioSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'StudioSummary', ], ], 'SubnetIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'SupportedInstanceType' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'MemoryGB' => [ 'shape' => 'Float', ], 'StorageGB' => [ 'shape' => 'Integer', ], 'VCPU' => [ 'shape' => 'Integer', ], 'Is64BitsOnly' => [ 'shape' => 'Boolean', ], 'InstanceFamilyId' => [ 'shape' => 'String', ], 'EbsOptimizedAvailable' => [ 'shape' => 'Boolean', ], 'EbsOptimizedByDefault' => [ 'shape' => 'Boolean', ], 'NumberOfDisks' => [ 'shape' => 'Integer', ], 'EbsStorageOnly' => [ 'shape' => 'Boolean', ], 'Architecture' => [ 'shape' => 'String', ], ], ], 'SupportedInstanceTypesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SupportedInstanceType', ], ], 'SupportedProductConfig' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Args' => [ 'shape' => 'XmlStringList', ], ], ], 'SupportedProductsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TerminateJobFlowsInput' => [ 'type' => 'structure', 'required' => [ 'JobFlowIds', ], 'members' => [ 'JobFlowIds' => [ 'shape' => 'XmlStringList', ], ], ], 'ThroughputVal' => [ 'type' => 'integer', 'min' => 0, ], 'Unit' => [ 'type' => 'string', 'enum' => [ 'NONE', 'SECONDS', 'MICRO_SECONDS', 'MILLI_SECONDS', 'BYTES', 'KILO_BYTES', 'MEGA_BYTES', 'GIGA_BYTES', 'TERA_BYTES', 'BITS', 'KILO_BITS', 'MEGA_BITS', 'GIGA_BITS', 'TERA_BITS', 'PERCENT', 'COUNT', 'BYTES_PER_SECOND', 'KILO_BYTES_PER_SECOND', 'MEGA_BYTES_PER_SECOND', 'GIGA_BYTES_PER_SECOND', 'TERA_BYTES_PER_SECOND', 'BITS_PER_SECOND', 'KILO_BITS_PER_SECOND', 'MEGA_BITS_PER_SECOND', 'GIGA_BITS_PER_SECOND', 'TERA_BITS_PER_SECOND', 'COUNT_PER_SECOND', ], ], 'UpdateStudioInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'Name' => [ 'shape' => 'XmlStringMaxLen256', ], 'Description' => [ 'shape' => 'XmlStringMaxLen256', ], 'SubnetIds' => [ 'shape' => 'SubnetIdList', ], 'DefaultS3Location' => [ 'shape' => 'XmlString', ], 'EncryptionKeyArn' => [ 'shape' => 'XmlString', ], ], ], 'UpdateStudioSessionMappingInput' => [ 'type' => 'structure', 'required' => [ 'StudioId', 'IdentityType', 'SessionPolicyArn', ], 'members' => [ 'StudioId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityId' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityName' => [ 'shape' => 'XmlStringMaxLen256', ], 'IdentityType' => [ 'shape' => 'IdentityType', ], 'SessionPolicyArn' => [ 'shape' => 'XmlStringMaxLen256', ], ], ], 'UriString' => [ 'type' => 'string', 'max' => 10280, 'min' => 1, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*', ], 'UsernamePassword' => [ 'type' => 'structure', 'members' => [ 'Username' => [ 'shape' => 'XmlStringMaxLen256', ], 'Password' => [ 'shape' => 'XmlStringMaxLen256', ], ], 'sensitive' => true, ], 'VolumeSpecification' => [ 'type' => 'structure', 'required' => [ 'VolumeType', 'SizeInGB', ], 'members' => [ 'VolumeType' => [ 'shape' => 'String', ], 'Iops' => [ 'shape' => 'Integer', ], 'SizeInGB' => [ 'shape' => 'Integer', ], 'Throughput' => [ 'shape' => 'ThroughputVal', ], ], ], 'WholeNumber' => [ 'type' => 'integer', 'min' => 0, ], 'XmlString' => [ 'type' => 'string', 'max' => 10280, 'min' => 0, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*', ], 'XmlStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlString', ], ], 'XmlStringMaxLen256' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*', ], 'XmlStringMaxLen256List' => [ 'type' => 'list', 'member' => [ 'shape' => 'XmlStringMaxLen256', ], ], ],]; diff --git a/src/data/elasticmapreduce/2009-03-31/docs-2.json b/src/data/elasticmapreduce/2009-03-31/docs-2.json index 2679ea5f16..2da61ffe7d 100644 --- a/src/data/elasticmapreduce/2009-03-31/docs-2.json +++ b/src/data/elasticmapreduce/2009-03-31/docs-2.json @@ -1484,7 +1484,9 @@ "refs": { "CloudWatchAlarmDefinition$Threshold": "The value against which the specified statistic is compared.
", "InstanceTypeConfig$BidPriceAsPercentageOfOnDemandPrice": "The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType
. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is provided, BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType
. Expressed as a number (for example, 20 specifies 20%).
The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
", + "InstanceTypeSpecification$BidPriceAsPercentageOfOnDemandPrice": "The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType
. Expressed as a number (for example, 20 specifies 20%).
The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
" } }, "NotebookExecution": { @@ -1559,7 +1561,7 @@ "OnDemandProvisioningAllocationStrategy": { "base": null, "refs": { - "OnDemandProvisioningSpecification$AllocationStrategy": "Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is lowest-price
(the default), which launches the lowest price first.
Specifies the strategy to use in launching On-Demand instance fleets. Available options are lowest-price
and prioritized
. lowest-price
specifies to launch the instances with the lowest price first, and prioritized
specifies that Amazon EMR should launch the instances with the highest priority first. The default is lowest-price
.
Specifies one of the following strategies to launch Spot Instance fleets: price-capacity-optimized
, capacity-optimized
, lowest-price
, or diversified
. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.
When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized
strategy. You can't change the allocation strategy from the old console.
Specifies one of the following strategies to launch Spot Instance fleets: capacity-optimized
, price-capacity-optimized
, lowest-price
, or diversified
, and capacity-optimized-prioritized
. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.
When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized
strategy. You can't change the allocation strategy from the old console.
Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management.
', 'operations' => [ 'AddInstanceFleet' => 'Adds an instance fleet to a running cluster.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x.
Adds one or more instance groups to a running cluster.
', 'AddJobFlowSteps' => 'AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.
If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop.
A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.
Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.
You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.
The string values passed into HadoopJarStep
object cannot exceed a total of 10240 characters.
Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
', 'CancelSteps' => 'Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a PENDING
or RUNNING
state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING
state.
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
', 'CreateStudio' => 'Creates a new Amazon EMR Studio.
', 'CreateStudioSessionMapping' => 'Maps a user or group to the Amazon EMR Studio specified by StudioId
, and applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping
to assign users to a Studio when you use IAM Identity Center authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.
Deletes a security configuration.
', 'DeleteStudio' => 'Removes an Amazon EMR Studio from the Studio metadata store.
', 'DeleteStudioSessionMapping' => 'Removes a user or group from an Amazon EMR Studio.
', 'DescribeCluster' => 'Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
', 'DescribeJobFlows' => 'This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.
DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.
Regardless of supplied parameters, only job flows created within the last two months are returned.
If no parameters are supplied, then job flows matching either of the following criteria are returned:
Job flows created and completed in the last two weeks
Job flows created within the last two months that are in one of the following states: RUNNING
, WAITING
, SHUTTING_DOWN
, STARTING
Amazon EMR can return a maximum of 512 job flow descriptions.
', 'DescribeNotebookExecution' => 'Provides details of a notebook execution.
', 'DescribeReleaseLabel' => 'Provides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a specified version of Spark.
', 'DescribeSecurityConfiguration' => 'Provides the details of a security configuration by returning the configuration JSON.
', 'DescribeStep' => 'Provides more detail about the cluster step.
', 'DescribeStudio' => 'Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
', 'GetAutoTerminationPolicy' => 'Returns the auto-termination policy for an Amazon EMR cluster.
', 'GetBlockPublicAccessConfiguration' => 'Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
', 'GetClusterSessionCredentials' => 'Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.
', 'GetManagedScalingPolicy' => 'Fetches the attached managed scaling policy for an Amazon EMR cluster.
', 'GetStudioSessionMapping' => 'Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
', 'ListBootstrapActions' => 'Provides information about the bootstrap actions associated with a cluster.
', 'ListClusters' => 'Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.
', 'ListInstanceFleets' => 'Lists all available details about the instance fleets in a cluster.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides all available details about the instance groups in a cluster.
', 'ListInstances' => 'Provides information for all active Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
', 'ListNotebookExecutions' => 'Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecutions
calls.
Retrieves release labels of Amazon EMR services in the Region where the API is called.
', 'ListSecurityConfigurations' => 'Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.
', 'ListSteps' => 'Provides a list of steps for the cluster in reverse order unless you specify stepIds
with the request or filter by StepStates
. You can specify a maximum of 10 stepIDs
. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker
, which is a pagination token that indicates the next set of steps to retrieve.
Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId
.
Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.
', 'ListSupportedInstanceTypes' => 'A list of the instance types that Amazon EMR supports. You can filter the list by Amazon Web Services Region and Amazon EMR release.
', 'ModifyCluster' => 'Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
', 'ModifyInstanceFleet' => 'Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.
', 'PutAutoScalingPolicy' => 'Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric.
', 'PutAutoTerminationPolicy' => 'Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.
Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
', 'PutBlockPublicAccessConfiguration' => 'Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
', 'PutManagedScalingPolicy' => 'Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as Amazon EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'RemoveAutoScalingPolicy' => 'Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.
', 'RemoveAutoTerminationPolicy' => 'Removes an auto-termination policy from an Amazon EMR cluster.
', 'RemoveManagedScalingPolicy' => 'Removes a managed scaling policy from a specified Amazon EMR cluster.
', 'RemoveTags' => 'Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
The following example removes the stack tag with value Prod from a cluster:
', 'RunJobFlow' => 'RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps
parameter is set to TRUE
, the cluster transitions to the WAITING state rather than shutting down after the steps have completed.
For additional protection, you can set the JobFlowInstancesConfig TerminationProtected
parameter to TRUE
to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error.
A maximum of 256 steps are allowed in each job flow.
If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop.
For long-running clusters, we recommend that you periodically store your results.
The instance fleets configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.
You can use the SetKeepJobFlowAliveWhenNoSteps
to configure a cluster (job flow) to terminate after the step execution, i.e., all your steps are executed. If you want a transient cluster that shuts down after the last of the current executing steps are completed, you can configure SetKeepJobFlowAliveWhenNoSteps
to false. If you want a long running cluster, configure SetKeepJobFlowAliveWhenNoSteps
to true.
For more information, see Managing Cluster Termination in the Amazon EMR Management Guide.
', 'SetTerminationProtection' => 'SetTerminationProtection locks a cluster (job flow) so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection
on a cluster is similar to calling the Amazon EC2 DisableAPITermination
API on all Amazon EC2 instances in a cluster.
SetTerminationProtection
is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage.
To terminate a cluster that has been locked by setting SetTerminationProtection
to true
, you must first unlock the job flow by a subsequent call to SetTerminationProtection
in which you set the value to false
.
For more information, see Managing Cluster Termination in the Amazon EMR Management Guide.
', 'SetUnhealthyNodeReplacement' => 'Specify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully replace core nodes on a cluster if any nodes become unhealthy. For example, a node becomes unhealthy if disk usage is above 90%. If unhealthy node replacement is on and TerminationProtected
are off, Amazon EMR immediately terminates the unhealthy core nodes. To use unhealthy node replacement and retain unhealthy core nodes, use to turn on termination protection. In such cases, Amazon EMR adds the unhealthy nodes to a denylist, reducing job interruptions and failures.
If unhealthy node replacement is on, Amazon EMR notifies YARN and other applications on the cluster to stop scheduling tasks with these nodes, moves the data, and then terminates the nodes.
For more information, see graceful node replacement in the Amazon EMR Management Guide.
', 'SetVisibleToAllUsers' => 'The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access Management for Amazon EMR.
Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.
This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.
For more information, see Understanding the Amazon EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.
', 'StartNotebookExecution' => 'Starts a notebook execution.
', 'StopNotebookExecution' => 'Stops a notebook execution.
', 'TerminateJobFlows' => 'TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the Amazon EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.
The maximum number of clusters allowed is 10. The call to TerminateJobFlows
is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.
Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
', 'UpdateStudioSessionMapping' => 'Updates the session policy attached to the user or group for the specified Amazon EMR Studio.
', ], 'shapes' => [ 'ActionOnFailure' => [ 'base' => NULL, 'refs' => [ 'Step$ActionOnFailure' => 'The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER
, CANCEL_AND_WAIT
, and CONTINUE
. TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend using TERMINATE_CLUSTER
instead.
If a cluster\'s StepConcurrencyLevel
is greater than 1
, do not use AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the ActionOnFailure
setting is not valid.
If you change a cluster\'s StepConcurrencyLevel
to be greater than 1 while a step is running, the ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
The action to take when the step fails. Use one of the following values:
TERMINATE_CLUSTER
- Shuts down the cluster.
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to the WAITING
state.
CONTINUE
- Continues to the next step in the queue.
TERMINATE_JOB_FLOW
- Shuts down the cluster. TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend using TERMINATE_CLUSTER
instead.
If a cluster\'s StepConcurrencyLevel
is greater than 1
, do not use AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the ActionOnFailure
setting is not valid.
If you change a cluster\'s StepConcurrencyLevel
to be greater than 1 while a step is running, the ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility.
', ], ], 'AddInstanceFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'AddInstanceFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'AddInstanceGroupsInput' => [ 'base' => 'Input to an AddInstanceGroups call.
', 'refs' => [], ], 'AddInstanceGroupsOutput' => [ 'base' => 'Output from an AddInstanceGroups call.
', 'refs' => [], ], 'AddJobFlowStepsInput' => [ 'base' => 'The input argument to the AddJobFlowSteps operation.
', 'refs' => [], ], 'AddJobFlowStepsOutput' => [ 'base' => 'The output for the AddJobFlowSteps operation.
', 'refs' => [], ], 'AddTagsInput' => [ 'base' => 'This input identifies an Amazon EMR resource and a list of tags to attach.
', 'refs' => [], ], 'AddTagsOutput' => [ 'base' => 'This output indicates the result of adding tags to a resource.
', 'refs' => [], ], 'AdjustmentType' => [ 'base' => NULL, 'refs' => [ 'SimpleScalingPolicyConfiguration$AdjustmentType' => 'The way in which Amazon EC2 instances are added (if ScalingAdjustment
is a positive number) or terminated (if ScalingAdjustment
is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY
is the default. CHANGE_IN_CAPACITY
indicates that the Amazon EC2 instance count increments or decrements by ScalingAdjustment
, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY
indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment
, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY
indicates the scaling activity results in an instance group with the number of Amazon EC2 instances specified by ScalingAdjustment
, which should be expressed as a positive integer.
With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see Configuring Applications.
With earlier Amazon EMR releases, the application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument.
', 'refs' => [ 'ApplicationList$member' => NULL, ], ], 'ApplicationList' => [ 'base' => NULL, 'refs' => [ 'Cluster$Applications' => 'The applications installed on this cluster.
', 'RunJobFlowInput$Applications' => 'Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMRRelease Guide.
', ], ], 'ArnType' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetOutput$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'AddInstanceGroupsOutput$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'AddJobFlowStepsInput$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
.
For example, arn:aws:IAM::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
The Amazon Resource Name that created or last modified the configuration.
', 'Cluster$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'ClusterSummary$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'CreateStudioInput$IdcInstanceArn' => 'The ARN of the IAM Identity Center instance to create the Studio application.
', 'GetClusterSessionCredentialsInput$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for interactive workload submission on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
.
The Amazon Resource Name (ARN) of the cluster.
', 'RunJobFlowOutput$ClusterArn' => 'The Amazon Resource Name (ARN) of the cluster.
', 'Studio$IdcInstanceArn' => 'The ARN of the IAM Identity Center instance the Studio application belongs to.
', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateStudioInput$AuthMode' => 'Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
', 'Studio$AuthMode' => 'Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
', 'StudioSummary$AuthMode' => 'Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
', ], ], 'AutoScalingPolicy' => [ 'base' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'refs' => [ 'InstanceGroupConfig$AutoScalingPolicy' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'PutAutoScalingPolicyInput$AutoScalingPolicy' => 'Specifies the definition of the automatic scaling policy.
', ], ], 'AutoScalingPolicyDescription' => [ 'base' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'refs' => [ 'InstanceGroup$AutoScalingPolicy' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'PutAutoScalingPolicyOutput$AutoScalingPolicy' => 'The automatic scaling policy definition.
', ], ], 'AutoScalingPolicyState' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicyStatus$State' => 'Indicates the status of the automatic scaling policy.
', ], ], 'AutoScalingPolicyStateChangeReason' => [ 'base' => 'The reason for an AutoScalingPolicyStatus change.
', 'refs' => [ 'AutoScalingPolicyStatus$StateChangeReason' => 'The reason for a change in status.
', ], ], 'AutoScalingPolicyStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicyStateChangeReason$Code' => 'The code indicating the reason for the change in status.USER_REQUEST
indicates that the scaling policy status was changed by a user. PROVISION_FAILURE
indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE
indicates an error.
The status of an automatic scaling policy.
', 'refs' => [ 'AutoScalingPolicyDescription$Status' => 'The status of an automatic scaling policy.
', ], ], 'AutoTerminationPolicy' => [ 'base' => 'An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
', 'refs' => [ 'GetAutoTerminationPolicyOutput$AutoTerminationPolicy' => 'Specifies the auto-termination policy that is attached to an Amazon EMR cluster.
', 'PutAutoTerminationPolicyInput$AutoTerminationPolicy' => 'Specifies the auto-termination policy to attach to the cluster.
', 'RunJobFlowInput$AutoTerminationPolicy' => NULL, ], ], 'BlockPublicAccessConfiguration' => [ 'base' => 'A configuration for Amazon EMR block public access. When BlockPublicSecurityGroupRules
is set to true
, Amazon EMR prevents cluster creation if one of the cluster\'s security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges
.
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges
in the BlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an Amazon EMR cluster in a Region before this date, block public access is enabled by default in that Region.
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges
in the BlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules
to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an Amazon EMR cluster in a Region before this date, block public access is enabled by default in that Region.
Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration
using the PutBlockPublicAccessConfiguration
action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration
using the PutBlockPublicAccessConfiguration
action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
Indicates whether Amazon EMR block public access is enabled (true
) or disabled (false
). By default, the value is false
for accounts that have created Amazon EMR clusters before July 2019. For accounts created after this, the default is true
.
Specifies whether the cluster should terminate after completing all steps.
', 'Cluster$TerminationProtected' => 'Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
', 'Cluster$VisibleToAllUsers' => 'Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Specifies whether the cluster should remain available after completing all steps. Defaults to false
. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.
Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.
', 'JobFlowInstancesDetail$KeepJobFlowAliveWhenNoSteps' => 'Specifies whether the cluster should remain available after completing all steps.
', 'JobFlowInstancesDetail$TerminationProtected' => 'Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.
', 'RunJobFlowInput$VisibleToAllUsers' => 'The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true
. Setting it to false
now has no effect.
Set this value to true
so that IAM principals in the Amazon Web Services account associated with the cluster can perform Amazon EMR actions on the cluster that their IAM policies allow. This value defaults to true
for clusters created using the Amazon EMR API or the CLI create-cluster command.
When set to false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the Amazon EMR Management Guide.
A Boolean that indicates whether to terminate the cluster after all steps are executed.
', 'SetTerminationProtectionInput$TerminationProtected' => 'A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
', 'SetVisibleToAllUsersInput$VisibleToAllUsers' => 'A value of true
indicates that an IAM principal in the Amazon Web Services account can perform Amazon EMR actions on the cluster that the IAM policies attached to the principal allow. A value of false
indicates that only the IAM principal that created the cluster and the Amazon Web Services root user can perform Amazon EMR actions on the cluster.
Indicates whether the SupportedInstanceType
only supports 64-bit architecture.
Indicates whether the SupportedInstanceType
supports Amazon EBS optimization.
Indicates whether the SupportedInstanceType
uses Amazon EBS optimization by default.
Indicates whether the SupportedInstanceType
only supports Amazon EBS.
Indicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.
', 'CreateStudioInput$TrustedIdentityPropagationEnabled' => ' A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false
.
Indicates whether an Amazon EBS volume is EBS-optimized.
', 'InstanceGroup$EbsOptimized' => 'If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
', 'InstanceTypeSpecification$EbsOptimized' => 'Evaluates to TRUE
when the specified InstanceType
is EBS-optimized.
Indicates whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster.
', 'JobFlowInstancesDetail$UnhealthyNodeReplacement' => 'Indicates whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster.
', 'SetUnhealthyNodeReplacementInput$UnhealthyNodeReplacement' => 'Indicates whether to turn on or turn off graceful unhealthy node replacement.
', 'Studio$TrustedIdentityPropagationEnabled' => ' Indicates whether the Studio has Trusted identity propagation enabled. The default value is false
.
Configuration of a bootstrap action.
', 'refs' => [ 'BootstrapActionConfigList$member' => NULL, 'BootstrapActionDetail$BootstrapActionConfig' => 'A description of the bootstrap action.
', ], ], 'BootstrapActionConfigList' => [ 'base' => NULL, 'refs' => [ 'RunJobFlowInput$BootstrapActions' => 'A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
', ], ], 'BootstrapActionDetail' => [ 'base' => 'Reports the configuration of a bootstrap action in a cluster (job flow).
', 'refs' => [ 'BootstrapActionDetailList$member' => NULL, ], ], 'BootstrapActionDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$BootstrapActions' => 'A list of the bootstrap actions run by the job flow.
', ], ], 'CancelStepsInfo' => [ 'base' => 'Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.
', 'refs' => [ 'CancelStepsInfoList$member' => NULL, ], ], 'CancelStepsInfoList' => [ 'base' => NULL, 'refs' => [ 'CancelStepsOutput$CancelStepsInfoList' => 'A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID
specified.
The input argument to the CancelSteps operation.
', 'refs' => [], ], 'CancelStepsOutput' => [ 'base' => 'The output for the CancelSteps operation.
', 'refs' => [], ], 'CancelStepsRequestStatus' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInfo$Status' => 'The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.
', ], ], 'CloudWatchAlarmDefinition' => [ 'base' => 'The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.
', 'refs' => [ 'ScalingTrigger$CloudWatchAlarmDefinition' => 'The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
', ], ], 'Cluster' => [ 'base' => 'The detailed description of the cluster.
', 'refs' => [ 'DescribeClusterOutput$Cluster' => 'This output contains the details for the requested cluster.
', ], ], 'ClusterId' => [ 'base' => NULL, 'refs' => [ 'Cluster$Id' => 'The unique identifier for the cluster.
', 'ClusterSummary$Id' => 'The unique identifier for the cluster.
', 'DescribeClusterInput$ClusterId' => 'The identifier of the cluster to describe.
', 'DescribeStepInput$ClusterId' => 'The identifier of the cluster with steps to describe.
', 'GetAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster for which the auto-termination policy will be fetched.
', 'GetManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of the cluster for which the managed scaling policy will be fetched.
', 'ListBootstrapActionsInput$ClusterId' => 'The cluster identifier for the bootstrap actions to list.
', 'ListInstanceFleetsInput$ClusterId' => 'The unique identifier of the cluster.
', 'ListInstanceGroupsInput$ClusterId' => 'The identifier of the cluster for which to list the instance groups.
', 'ListInstancesInput$ClusterId' => 'The identifier of the cluster for which to list the instances.
', 'ListStepsInput$ClusterId' => 'The identifier of the cluster for which to list the steps.
', 'ModifyInstanceFleetInput$ClusterId' => 'The unique identifier of the cluster.
', 'ModifyInstanceGroupsInput$ClusterId' => 'The ID of the cluster to which the instance group belongs.
', 'PutAutoScalingPolicyInput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'PutAutoScalingPolicyOutput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'PutAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster to which the auto-termination policy will be attached.
', 'PutManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of an Amazon EMR cluster where the managed scaling policy is attached.
', 'RemoveAutoScalingPolicyInput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'RemoveAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster from which the auto-termination policy will be removed.
', 'RemoveManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of the cluster from which the managed scaling policy will be removed.
', ], ], 'ClusterState' => [ 'base' => NULL, 'refs' => [ 'ClusterStateList$member' => NULL, 'ClusterStatus$State' => 'The current state of the cluster.
', ], ], 'ClusterStateChangeReason' => [ 'base' => 'The reason that the cluster changed to its current state.
', 'refs' => [ 'ClusterStatus$StateChangeReason' => 'The reason for the cluster status change.
', ], ], 'ClusterStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'ClusterStateChangeReason$Code' => 'The programmatic code for the state change reason.
', ], ], 'ClusterStateList' => [ 'base' => NULL, 'refs' => [ 'ListClustersInput$ClusterStates' => 'The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.
', ], ], 'ClusterStatus' => [ 'base' => 'The detailed status of the cluster.
', 'refs' => [ 'Cluster$Status' => 'The current status details about the cluster.
', 'ClusterSummary$Status' => 'The details about the current status of the cluster.
', ], ], 'ClusterSummary' => [ 'base' => 'The summary description of the cluster.
', 'refs' => [ 'ClusterSummaryList$member' => NULL, ], ], 'ClusterSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListClustersOutput$Clusters' => 'The list of clusters for the account based on the given filters.
', ], ], 'ClusterTimeline' => [ 'base' => 'Represents the timeline of the cluster\'s lifecycle.
', 'refs' => [ 'ClusterStatus$Timeline' => 'A timeline that represents the status of a cluster over the lifetime of the cluster.
', ], ], 'Command' => [ 'base' => 'An entity describing an executable that runs on a cluster.
', 'refs' => [ 'CommandList$member' => NULL, ], ], 'CommandList' => [ 'base' => NULL, 'refs' => [ 'ListBootstrapActionsOutput$BootstrapActions' => 'The bootstrap actions associated with the cluster.
', ], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$ComparisonOperator' => 'Determines how the metric specified by MetricName
is compared to the value specified by Threshold
.
The Amazon EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not be above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'refs' => [ 'ManagedScalingPolicy$ComputeLimits' => 'The Amazon EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is not allowed to go above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', ], ], 'ComputeLimitsUnitType' => [ 'base' => NULL, 'refs' => [ 'ComputeLimits$UnitType' => 'The unit type used for specifying a managed scaling policy.
', ], ], 'Configuration' => [ 'base' => 'Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications.
', 'refs' => [ 'ConfigurationList$member' => NULL, ], ], 'ConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Cluster$Configurations' => 'Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.
', 'Configuration$Configurations' => 'A list of additional configurations to apply within a configuration object.
', 'InstanceGroup$Configurations' => 'Amazon EMR releases 4.x or later.
The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
', 'InstanceGroup$LastSuccessfullyAppliedConfigurations' => 'A list of configurations that were successfully applied for an instance group last time.
', 'InstanceGroupConfig$Configurations' => 'Amazon EMR releases 4.x or later.
The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
', 'InstanceGroupModifyConfig$Configurations' => 'A list of new or modified configurations to apply for an instance group.
', 'InstanceTypeConfig$Configurations' => 'A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
', 'InstanceTypeSpecification$Configurations' => 'A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
', 'RunJobFlowInput$Configurations' => 'For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
', ], ], 'CreateSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioSessionMappingInput' => [ 'base' => NULL, 'refs' => [], ], 'Credentials' => [ 'base' => 'The credentials that you can use to connect to cluster endpoints. Credentials consist of a username and a password.
', 'refs' => [ 'GetClusterSessionCredentialsOutput$Credentials' => 'The credentials that you can use to connect to cluster endpoints that support username and password authentication.
', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'BlockPublicAccessConfigurationMetadata$CreationDateTime' => 'The date and time that the configuration was created.
', 'ClusterTimeline$CreationDateTime' => 'The creation date and time of the cluster.
', 'ClusterTimeline$ReadyDateTime' => 'The date and time when the cluster was ready to run steps.
', 'ClusterTimeline$EndDateTime' => 'The date and time when the cluster was terminated.
', 'CreateSecurityConfigurationOutput$CreationDateTime' => 'The date and time the security configuration was created.
', 'DescribeJobFlowsInput$CreatedAfter' => 'Return only job flows created after this date and time.
', 'DescribeJobFlowsInput$CreatedBefore' => 'Return only job flows created before this date and time.
', 'DescribeSecurityConfigurationOutput$CreationDateTime' => 'The date and time the security configuration was created
', 'GetClusterSessionCredentialsOutput$ExpiresAt' => 'The time when the credentials that are returned by the GetClusterSessionCredentials
API expire.
The time and date the instance fleet was created.
', 'InstanceFleetTimeline$ReadyDateTime' => 'The time and date the instance fleet was ready to run jobs.
', 'InstanceFleetTimeline$EndDateTime' => 'The time and date the instance fleet terminated.
', 'InstanceGroupDetail$CreationDateTime' => 'The date/time the instance group was created.
', 'InstanceGroupDetail$StartDateTime' => 'The date/time the instance group was started.
', 'InstanceGroupDetail$ReadyDateTime' => 'The date/time the instance group was available to the cluster.
', 'InstanceGroupDetail$EndDateTime' => 'The date/time the instance group was terminated.
', 'InstanceGroupTimeline$CreationDateTime' => 'The creation date and time of the instance group.
', 'InstanceGroupTimeline$ReadyDateTime' => 'The date and time when the instance group became ready to perform tasks.
', 'InstanceGroupTimeline$EndDateTime' => 'The date and time when the instance group terminated.
', 'InstanceTimeline$CreationDateTime' => 'The creation date and time of the instance.
', 'InstanceTimeline$ReadyDateTime' => 'The date and time when the instance was ready to perform tasks.
', 'InstanceTimeline$EndDateTime' => 'The date and time when the instance was terminated.
', 'JobFlowExecutionStatusDetail$CreationDateTime' => 'The creation date and time of the job flow.
', 'JobFlowExecutionStatusDetail$StartDateTime' => 'The start date and time of the job flow.
', 'JobFlowExecutionStatusDetail$ReadyDateTime' => 'The date and time when the job flow was ready to start running bootstrap actions.
', 'JobFlowExecutionStatusDetail$EndDateTime' => 'The completion date and time of the job flow.
', 'ListClustersInput$CreatedAfter' => 'The creation date and time beginning value filter for listing clusters.
', 'ListClustersInput$CreatedBefore' => 'The creation date and time end value filter for listing clusters.
', 'ListNotebookExecutionsInput$From' => 'The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
', 'ListNotebookExecutionsInput$To' => 'The end of time range filter for listing notebook executions. The default is the current timestamp.
', 'NotebookExecution$StartTime' => 'The timestamp when notebook execution started.
', 'NotebookExecution$EndTime' => 'The timestamp when notebook execution ended.
', 'NotebookExecutionSummary$StartTime' => 'The timestamp when notebook execution started.
', 'NotebookExecutionSummary$EndTime' => 'The timestamp when notebook execution started.
', 'SecurityConfigurationSummary$CreationDateTime' => 'The date and time the security configuration was created.
', 'SessionMappingDetail$CreationTime' => 'The time the session mapping was created.
', 'SessionMappingDetail$LastModifiedTime' => 'The time the session mapping was last modified.
', 'SessionMappingSummary$CreationTime' => 'The time the session mapping was created.
', 'StepExecutionStatusDetail$CreationDateTime' => 'The creation date and time of the step.
', 'StepExecutionStatusDetail$StartDateTime' => 'The start date and time of the step.
', 'StepExecutionStatusDetail$EndDateTime' => 'The completion date and time of the step.
', 'StepTimeline$CreationDateTime' => 'The date and time when the cluster step was created.
', 'StepTimeline$StartDateTime' => 'The date and time when the cluster step execution started.
', 'StepTimeline$EndDateTime' => 'The date and time when the cluster step execution completed or failed.
', 'Studio$CreationTime' => 'The time the Amazon EMR Studio was created.
', 'StudioSummary$CreationTime' => 'The time when the Amazon EMR Studio was created.
', ], ], 'DeleteSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioSessionMappingInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterInput' => [ 'base' => 'This input determines which cluster to describe.
', 'refs' => [], ], 'DescribeClusterOutput' => [ 'base' => 'This output contains the description of the cluster.
', 'refs' => [], ], 'DescribeJobFlowsInput' => [ 'base' => 'The input for the DescribeJobFlows operation.
', 'refs' => [], ], 'DescribeJobFlowsOutput' => [ 'base' => 'The output for the DescribeJobFlows operation.
', 'refs' => [], ], 'DescribeNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeReleaseLabelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeReleaseLabelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStepInput' => [ 'base' => 'This input determines which step to describe.
', 'refs' => [], ], 'DescribeStepOutput' => [ 'base' => 'This output contains the description of the cluster step.
', 'refs' => [], ], 'DescribeStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioOutput' => [ 'base' => NULL, 'refs' => [], ], 'EC2InstanceIdsList' => [ 'base' => NULL, 'refs' => [ 'InstanceResizePolicy$InstancesToTerminate' => 'Specific list of instances to be terminated when shrinking an instance group.
', 'InstanceResizePolicy$InstancesToProtect' => 'Specific list of instances to be protected when shrinking an instance group.
', ], ], 'EC2InstanceIdsToTerminateList' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupModifyConfig$EC2InstanceIdsToTerminate' => 'The Amazon EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
', ], ], 'EbsBlockDevice' => [ 'base' => 'Configuration of requested EBS block device associated with the instance group.
', 'refs' => [ 'EbsBlockDeviceList$member' => NULL, ], ], 'EbsBlockDeviceConfig' => [ 'base' => 'Configuration of requested EBS block device associated with the instance group with count of volumes that are associated to every instance.
', 'refs' => [ 'EbsBlockDeviceConfigList$member' => NULL, ], ], 'EbsBlockDeviceConfigList' => [ 'base' => NULL, 'refs' => [ 'EbsConfiguration$EbsBlockDeviceConfigs' => 'An array of Amazon EBS volume specifications attached to a cluster instance.
', ], ], 'EbsBlockDeviceList' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$EbsBlockDevices' => 'The EBS block devices that are mapped to this instance group.
', 'InstanceTypeSpecification$EbsBlockDevices' => 'The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType
.
The Amazon EBS configuration of a cluster instance.
', 'refs' => [ 'InstanceGroupConfig$EbsConfiguration' => 'EBS configurations that will be attached to each Amazon EC2 instance in the instance group.
', 'InstanceTypeConfig$EbsConfiguration' => 'The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType
.
EBS block device that\'s attached to an Amazon EC2 instance.
', 'refs' => [ 'EbsVolumeList$member' => NULL, ], ], 'EbsVolumeList' => [ 'base' => NULL, 'refs' => [ 'Instance$EbsVolumes' => 'The list of Amazon EBS volumes that are attached to this instance.
', ], ], 'Ec2InstanceAttributes' => [ 'base' => 'Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
', 'refs' => [ 'Cluster$Ec2InstanceAttributes' => 'Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
', ], ], 'EnvironmentVariablesMap' => [ 'base' => NULL, 'refs' => [ 'NotebookExecution$EnvironmentVariables' => 'The environment variables associated with the notebook execution.
', 'StartNotebookExecutionInput$EnvironmentVariables' => 'The environment variables associated with the notebook execution.
', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'InvalidRequestException$ErrorCode' => 'The error code associated with the exception.
', ], ], 'ErrorData' => [ 'base' => NULL, 'refs' => [ 'ErrorDetail$ErrorData' => 'A list of key value pairs that provides contextual information about why an error occured.
', ], ], 'ErrorDetail' => [ 'base' => 'A tuple that provides information about an error that caused a cluster to terminate.
', 'refs' => [ 'ErrorDetailList$member' => NULL, ], ], 'ErrorDetailList' => [ 'base' => NULL, 'refs' => [ 'ClusterStatus$ErrorDetails' => 'A list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different ErrorDetail
tuples.
The message associated with the exception.
', 'InvalidRequestException$Message' => 'The message associated with the exception.
', ], ], 'ExecutionEngineConfig' => [ 'base' => 'Specifies the execution engine (cluster) to run the notebook and perform the notebook execution, for example, an Amazon EMR cluster.
', 'refs' => [ 'NotebookExecution$ExecutionEngine' => 'The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
', 'StartNotebookExecutionInput$ExecutionEngine' => 'Specifies the execution engine (cluster) that runs the notebook execution.
', ], ], 'ExecutionEngineType' => [ 'base' => NULL, 'refs' => [ 'ExecutionEngineConfig$Type' => 'The type of execution engine. A value of EMR
specifies an Amazon EMR cluster.
The details of the step failure. The service attempts to detect the root cause for many common failures.
', 'refs' => [ 'StepStatus$FailureDetails' => 'The details for the step failure including reason, message, and log file path where the root cause was identified.
', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'SupportedInstanceType$MemoryGB' => 'The amount of memory that is available to Amazon EMR from the SupportedInstanceType
. The kernel and hypervisor software consume some memory, so this value might be lower than the overall memory for the instance type.
A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
', 'refs' => [ 'StepConfig$HadoopJarStep' => 'The JAR file used for the step.
', ], ], 'HadoopStepConfig' => [ 'base' => 'A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
', 'refs' => [ 'Step$Config' => 'The Hadoop job configuration of the cluster step.
', 'StepSummary$Config' => 'The Hadoop job configuration of the cluster step.
', ], ], 'IAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'ExecutionEngineConfig$ExecutionRoleArn' => 'The execution role ARN required for the notebook execution.
', ], ], 'IdcUserAssignment' => [ 'base' => NULL, 'refs' => [ 'CreateStudioInput$IdcUserAssignment' => ' Specifies whether IAM Identity Center user assignment is REQUIRED
or OPTIONAL
. If the value is set to REQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.
Indicates whether the Studio has REQUIRED
or OPTIONAL
IAM Identity Center user assignment. If the value is set to REQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.
Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.
', 'DeleteStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.
', 'GetStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to fetch is a user or a group.
', 'ListStudioSessionMappingsInput$IdentityType' => 'Specifies whether to return session mappings for users or groups. If not specified, the results include session mapping details for both users and groups.
', 'SessionMappingDetail$IdentityType' => 'Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
', 'SessionMappingSummary$IdentityType' => 'Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
', 'UpdateStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to update is a user or a group.
', ], ], 'Instance' => [ 'base' => 'Represents an Amazon EC2 instance provisioned as part of cluster.
', 'refs' => [ 'InstanceList$member' => NULL, ], ], 'InstanceCollectionType' => [ 'base' => NULL, 'refs' => [ 'Cluster$InstanceCollectionType' => 'The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The instance group configuration of the cluster. A value of INSTANCE_GROUP
indicates a uniform instance group configuration. A value of INSTANCE_FLEET
indicates an instance fleets configuration.
Describes an instance fleet, which is a group of Amazon EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The configuration that defines an instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Specifies the configuration of the instance fleet.
', 'InstanceFleetConfigList$member' => NULL, ], ], 'InstanceFleetConfigList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesConfig$InstanceFleets' => 'The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Describes the Amazon EC2 instances and instance configurations for clusters that use the instance fleet configuration.
', ], ], 'InstanceFleetId' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetOutput$InstanceFleetId' => 'The unique identifier of the instance fleet.
', 'Instance$InstanceFleetId' => 'The unique identifier of the instance fleet to which an Amazon EC2 instance belongs.
', 'InstanceFleet$Id' => 'The unique identifier of the instance fleet.
', 'InstanceFleetModifyConfig$InstanceFleetId' => 'A unique identifier for the instance fleet.
', 'ListInstancesInput$InstanceFleetId' => 'The unique identifier of the instance fleet.
', ], ], 'InstanceFleetList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceFleetsOutput$InstanceFleets' => 'The list of instance fleets for the cluster and given filters.
', ], ], 'InstanceFleetModifyConfig' => [ 'base' => 'Configuration parameters for an instance fleet modification request.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The configuration parameters of the instance fleet.
', ], ], 'InstanceFleetProvisioningSpecifications' => [ 'base' => 'The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation strategies are available in Amazon EMR releases 5.12.1 and later.
Describes the launch specification for an instance fleet.
', 'InstanceFleetConfig$LaunchSpecifications' => 'The launch specification for the instance fleet.
', ], ], 'InstanceFleetResizingSpecifications' => [ 'base' => 'The resize specification for On-Demand and Spot Instances in the fleet.
', 'refs' => [ 'InstanceFleet$ResizeSpecifications' => 'The resize specification for the instance fleet.
', 'InstanceFleetConfig$ResizeSpecifications' => 'The resize specification for the instance fleet.
', 'InstanceFleetModifyConfig$ResizeSpecifications' => 'The resize specification for the instance fleet.
', ], ], 'InstanceFleetState' => [ 'base' => NULL, 'refs' => [ 'InstanceFleetStatus$State' => 'A code representing the instance fleet status.
PROVISIONING
—The instance fleet is provisioning Amazon EC2 resources and is not yet ready to run jobs.
BOOTSTRAPPING
—Amazon EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway.
RUNNING
—Amazon EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs.
RESIZING
—A resize operation is underway. Amazon EC2 instances are either being added or removed.
SUSPENDED
—A resize operation could not complete. Existing Amazon EC2 instances are running, but instances can\'t be added or removed.
TERMINATING
—The instance fleet is terminating Amazon EC2 instances.
TERMINATED
—The instance fleet is no longer active, and all Amazon EC2 instances have been terminated.
Provides status change reason details for the instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides status change reason details for the instance fleet.
', ], ], 'InstanceFleetStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceFleetStateChangeReason$Code' => 'A code corresponding to the reason the state change occurred.
', ], ], 'InstanceFleetStatus' => [ 'base' => 'The status of the instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The current status of the instance fleet.
', ], ], 'InstanceFleetTimeline' => [ 'base' => 'Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
', ], ], 'InstanceFleetType' => [ 'base' => NULL, 'refs' => [ 'InstanceFleet$InstanceFleetType' => 'The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
', 'InstanceFleetConfig$InstanceFleetType' => 'The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.
', 'ListInstancesInput$InstanceFleetType' => 'The node type of the instance fleet. For example MASTER, CORE, or TASK.
', ], ], 'InstanceGroup' => [ 'base' => 'This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.
', 'refs' => [ 'InstanceGroupList$member' => NULL, ], ], 'InstanceGroupConfig' => [ 'base' => 'Configuration defining a new instance group.
', 'refs' => [ 'InstanceGroupConfigList$member' => NULL, ], ], 'InstanceGroupConfigList' => [ 'base' => NULL, 'refs' => [ 'AddInstanceGroupsInput$InstanceGroups' => 'Instance groups to add.
', 'JobFlowInstancesConfig$InstanceGroups' => 'Configuration for the instance groups in a cluster.
', ], ], 'InstanceGroupDetail' => [ 'base' => 'Detailed information about an instance group.
', 'refs' => [ 'InstanceGroupDetailList$member' => NULL, ], ], 'InstanceGroupDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesDetail$InstanceGroups' => 'Details about the instance groups in a cluster.
', ], ], 'InstanceGroupId' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$Id' => 'The identifier of the instance group.
', 'ListInstancesInput$InstanceGroupId' => 'The identifier of the instance group for which to list the instances.
', 'PutAutoScalingPolicyInput$InstanceGroupId' => 'Specifies the ID of the instance group to which the automatic scaling policy is applied.
', 'PutAutoScalingPolicyOutput$InstanceGroupId' => 'Specifies the ID of the instance group to which the scaling policy is applied.
', 'RemoveAutoScalingPolicyInput$InstanceGroupId' => 'Specifies the ID of the instance group to which the scaling policy is applied.
', ], ], 'InstanceGroupIdsList' => [ 'base' => NULL, 'refs' => [ 'AddInstanceGroupsOutput$InstanceGroupIds' => 'Instance group IDs of the newly created instance groups.
', ], ], 'InstanceGroupList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceGroupsOutput$InstanceGroups' => 'The list of instance groups for the cluster and given filters.
', ], ], 'InstanceGroupModifyConfig' => [ 'base' => 'Modify the size or configurations of an instance group.
', 'refs' => [ 'InstanceGroupModifyConfigList$member' => NULL, ], ], 'InstanceGroupModifyConfigList' => [ 'base' => NULL, 'refs' => [ 'ModifyInstanceGroupsInput$InstanceGroups' => 'Instance groups to change.
', ], ], 'InstanceGroupState' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupDetail$State' => 'State of instance group. The following values are no longer supported: STARTING, TERMINATED, and FAILED.
', 'InstanceGroupStatus$State' => 'The current state of the instance group.
', ], ], 'InstanceGroupStateChangeReason' => [ 'base' => 'The status change reason details for the instance group.
', 'refs' => [ 'InstanceGroupStatus$StateChangeReason' => 'The status change reason details for the instance group.
', ], ], 'InstanceGroupStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupStateChangeReason$Code' => 'The programmable code for the state change reason.
', ], ], 'InstanceGroupStatus' => [ 'base' => 'The details of the instance group status.
', 'refs' => [ 'InstanceGroup$Status' => 'The current status of the instance group.
', ], ], 'InstanceGroupTimeline' => [ 'base' => 'The timeline of the instance group lifecycle.
', 'refs' => [ 'InstanceGroupStatus$Timeline' => 'The timeline of the instance group status over time.
', ], ], 'InstanceGroupType' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupType' => 'The type of the instance group. Valid values are MASTER, CORE or TASK.
', 'InstanceGroupTypeList$member' => NULL, ], ], 'InstanceGroupTypeList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesInput$InstanceGroupTypes' => 'The type of instance group for which to list the instances.
', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'EC2InstanceIdsList$member' => NULL, 'EC2InstanceIdsToTerminateList$member' => NULL, 'Instance$Id' => 'The unique identifier for the instance in Amazon EMR.
', 'Instance$Ec2InstanceId' => 'The unique identifier of the instance in Amazon EC2.
', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesOutput$Instances' => 'The list of instances for the cluster and given filters.
', ], ], 'InstanceResizePolicy' => [ 'base' => 'Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
', 'refs' => [ 'ShrinkPolicy$InstanceResizePolicy' => 'Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
', ], ], 'InstanceRoleType' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupConfig$InstanceRole' => 'The role of the instance group in the cluster.
', 'InstanceGroupDetail$InstanceRole' => 'Instance group role in the cluster
', 'PlacementGroupConfig$InstanceRole' => 'Role of the instance in the cluster.
Starting with Amazon EMR release 5.23.0, the only supported instance role is MASTER
.
The current state of the instance.
', ], ], 'InstanceStateChangeReason' => [ 'base' => 'The details of the status change reason for the instance.
', 'refs' => [ 'InstanceStatus$StateChangeReason' => 'The details of the status change reason for the instance.
', ], ], 'InstanceStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceStateChangeReason$Code' => 'The programmable code for the state change reason.
', ], ], 'InstanceStateList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesInput$InstanceStates' => 'A list of instance states that will filter the instances returned with this request.
', ], ], 'InstanceStatus' => [ 'base' => 'The instance status details.
', 'refs' => [ 'Instance$Status' => 'The current status of the instance.
', ], ], 'InstanceTimeline' => [ 'base' => 'The timeline of the instance lifecycle.
', 'refs' => [ 'InstanceStatus$Timeline' => 'The timeline of the instance status over time.
', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'Instance$InstanceType' => 'The Amazon EC2 instance type, for example m3.xlarge
.
The Amazon EC2 instance type for all instances in the instance group.
', 'InstanceGroupConfig$InstanceType' => 'The Amazon EC2 instance type for all instances in the instance group.
', 'InstanceGroupDetail$InstanceType' => 'Amazon EC2 instance type.
', 'InstanceTypeConfig$InstanceType' => 'An Amazon EC2 instance type, such as m3.xlarge
.
The Amazon EC2 instance type, for example m3.xlarge
.
The Amazon EC2 instance type of the master node.
', 'JobFlowInstancesConfig$SlaveInstanceType' => 'The Amazon EC2 instance type of the core and task nodes.
', 'JobFlowInstancesDetail$MasterInstanceType' => 'The Amazon EC2 master node instance type.
', 'JobFlowInstancesDetail$SlaveInstanceType' => 'The Amazon EC2 core and task node instance type.
', ], ], 'InstanceTypeConfig' => [ 'base' => 'An instance type configuration for each instance type in an instance fleet, which determines the Amazon EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can include a maximum of 30 instance type configurations for a fleet. For more information about how to use an allocation strategy, see Configure Instance Fleets. Without an allocation strategy, you may specify a maximum of five instance type configurations for a fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The instance type configurations that define the Amazon EC2 instances in the instance fleet.
', ], ], 'InstanceTypeSpecification' => [ 'base' => 'The configuration specification for each instance type in an instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
An array of specifications for the instance types that comprise an instance fleet.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$EvaluationPeriods' => 'The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1
.
The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300
.
An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
', 'Cluster$EbsRootVolumeSize' => 'The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.
', 'Cluster$StepConcurrencyLevel' => 'Specifies the number of steps that can be executed concurrently.
', 'Cluster$EbsRootVolumeIops' => 'The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
', 'Cluster$EbsRootVolumeThroughput' => 'The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
', 'ClusterSummary$NormalizedInstanceHours' => 'An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
', 'ComputeLimits$MinimumCapacityUnits' => 'The lower boundary of Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'ComputeLimits$MaximumCapacityUnits' => 'The upper boundary of Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'ComputeLimits$MaximumOnDemandCapacityUnits' => 'The upper boundary of On-Demand Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. The On-Demand units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between On-Demand and Spot Instances.
', 'ComputeLimits$MaximumCoreCapacityUnits' => 'The upper boundary of Amazon EC2 units for core node type in a cluster. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. The core units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between core and task nodes.
', 'EbsBlockDeviceConfig$VolumesPerInstance' => 'Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group
', 'InstanceGroup$RequestedInstanceCount' => 'The target number of instances for the instance group.
', 'InstanceGroup$RunningInstanceCount' => 'The number of instances currently running in this instance group.
', 'InstanceGroupConfig$InstanceCount' => 'Target number of instances for the instance group.
', 'InstanceGroupDetail$InstanceRequestCount' => 'Target number of instances to run in the instance group.
', 'InstanceGroupDetail$InstanceRunningCount' => 'Actual count of running instances.
', 'InstanceGroupModifyConfig$InstanceCount' => 'Target size for the instance group.
', 'InstanceResizePolicy$InstanceTerminationTimeout' => 'Decommissioning timeout override for the specific list of instances to be terminated.
', 'JobFlowInstancesConfig$InstanceCount' => 'The number of Amazon EC2 instances in the cluster.
', 'JobFlowInstancesDetail$InstanceCount' => 'The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.
', 'JobFlowInstancesDetail$NormalizedInstanceHours' => 'An approximation of the cost of the cluster, represented in m1.small/hours. This value is increased one time for every hour that an m1.small instance runs. Larger instances are weighted more heavily, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being increased incrementally four times. This result is only an approximation and does not reflect the actual billing rate.
', 'ModifyClusterInput$StepConcurrencyLevel' => 'The number of steps that can be executed concurrently. You can specify a minimum of 1 step and a maximum of 256 steps. We recommend that you do not change this parameter while steps are running or the ActionOnFailure
setting may not behave as expected. For more information see Step$ActionOnFailure.
The number of steps that can be executed concurrently.
', 'RunJobFlowInput$EbsRootVolumeSize' => 'The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.
', 'RunJobFlowInput$StepConcurrencyLevel' => 'Specifies the number of steps that can be executed concurrently. The default value is 1
. The maximum value is 256
.
The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
', 'RunJobFlowInput$EbsRootVolumeThroughput' => 'The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
', 'ScalingConstraints$MinCapacity' => 'The lower boundary of Amazon EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.
', 'ScalingConstraints$MaxCapacity' => 'The upper boundary of Amazon EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.
', 'ShrinkPolicy$DecommissionTimeout' => 'The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
', 'SimpleScalingPolicyConfiguration$ScalingAdjustment' => 'The amount by which to scale in or scale out, based on the specified AdjustmentType
. A positive value adds to the instance group\'s Amazon EC2 instance count while a negative number removes instances. If AdjustmentType
is set to EXACT_CAPACITY
, the number should only be a positive integer. If AdjustmentType
is set to PERCENT_CHANGE_IN_CAPACITY
, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.
', 'SupportedInstanceType$StorageGB' => ' StorageGB
represents the storage capacity of the SupportedInstanceType
. This value is 0
for Amazon EBS-only instance types.
The number of vCPUs available for the SupportedInstanceType
.
Number of disks for the SupportedInstanceType
. This value is 0
for Amazon EBS-only instance types.
The number of I/O operations per second (IOPS) that the volume supports.
', 'VolumeSpecification$SizeInGB' => 'The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
', ], ], 'InternalServerError' => [ 'base' => 'Indicates that an error occurred while processing the request and that the request was not completed.
', 'refs' => [], ], 'InternalServerException' => [ 'base' => 'This exception occurs when there is an internal failure in the Amazon EMR service.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'This exception occurs when there is something wrong with user input.
', 'refs' => [], ], 'JobFlowDetail' => [ 'base' => 'A description of a cluster (job flow).
', 'refs' => [ 'JobFlowDetailList$member' => NULL, ], ], 'JobFlowDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsOutput$JobFlows' => 'A list of job flows matching the parameters supplied.
', ], ], 'JobFlowExecutionState' => [ 'base' => 'The type of instance.
', 'refs' => [ 'JobFlowExecutionStateList$member' => NULL, 'JobFlowExecutionStatusDetail$State' => 'The state of the job flow.
', ], ], 'JobFlowExecutionStateList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsInput$JobFlowStates' => 'Return only job flows whose state is contained in this list.
', ], ], 'JobFlowExecutionStatusDetail' => [ 'base' => 'Describes the status of the cluster (job flow).
', 'refs' => [ 'JobFlowDetail$ExecutionStatusDetail' => 'Describes the execution status of the job flow.
', ], ], 'JobFlowInstancesConfig' => [ 'base' => 'A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don\'t recommend this configuration.
', 'refs' => [ 'RunJobFlowInput$Instances' => 'A specification of the number and type of Amazon EC2 instances.
', ], ], 'JobFlowInstancesDetail' => [ 'base' => 'Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.
', 'refs' => [ 'JobFlowDetail$Instances' => 'Describes the Amazon EC2 instances of the job flow.
', ], ], 'KerberosAttributes' => [ 'base' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', 'refs' => [ 'Cluster$KerberosAttributes' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', 'RunJobFlowInput$KerberosAttributes' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', ], ], 'KeyValue' => [ 'base' => 'A key-value pair.
', 'refs' => [ 'KeyValueList$member' => NULL, ], ], 'KeyValueList' => [ 'base' => NULL, 'refs' => [ 'HadoopJarStepConfig$Properties' => 'A list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.
', ], ], 'ListBootstrapActionsInput' => [ 'base' => 'This input determines which bootstrap actions to retrieve.
', 'refs' => [], ], 'ListBootstrapActionsOutput' => [ 'base' => 'This output contains the bootstrap actions detail.
', 'refs' => [], ], 'ListClustersInput' => [ 'base' => 'This input determines how the ListClusters action filters the list of clusters that it returns.
', 'refs' => [], ], 'ListClustersOutput' => [ 'base' => 'This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.
', 'refs' => [], ], 'ListInstanceFleetsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceFleetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceGroupsInput' => [ 'base' => 'This input determines which instance groups to retrieve.
', 'refs' => [], ], 'ListInstanceGroupsOutput' => [ 'base' => 'This input determines which instance groups to retrieve.
', 'refs' => [], ], 'ListInstancesInput' => [ 'base' => 'This input determines which instances to list.
', 'refs' => [], ], 'ListInstancesOutput' => [ 'base' => 'This output contains the list of instances.
', 'refs' => [], ], 'ListNotebookExecutionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookExecutionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReleaseLabelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReleaseLabelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityConfigurationsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStepsInput' => [ 'base' => 'This input determines which steps to list.
', 'refs' => [], ], 'ListStepsOutput' => [ 'base' => 'This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.
', 'refs' => [], ], 'ListStudioSessionMappingsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioSessionMappingsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudiosInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudiosOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedInstanceTypesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedInstanceTypesOutput' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AutoTerminationPolicy$IdleTimeout' => 'Specifies the amount of idle time in seconds after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).
', 'InstanceGroup$ConfigurationsVersion' => 'The version number of the requested configuration specification for this instance group.
', 'InstanceGroup$LastSuccessfullyAppliedConfigurationsVersion' => 'The version number of a configuration specification that was successfully applied for an instance group last time.
', ], ], 'ManagedScalingPolicy' => [ 'base' => 'Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'refs' => [ 'GetManagedScalingPolicyOutput$ManagedScalingPolicy' => 'Specifies the managed scaling policy that is attached to an Amazon EMR cluster.
', 'PutManagedScalingPolicyInput$ManagedScalingPolicy' => 'Specifies the constraints for the managed scaling policy.
', 'RunJobFlowInput$ManagedScalingPolicy' => 'The specified managed scaling policy for an Amazon EMR cluster.
', ], ], 'Marker' => [ 'base' => NULL, 'refs' => [ 'ListBootstrapActionsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListBootstrapActionsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListClustersInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListClustersOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceFleetsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceFleetsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceGroupsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceGroupsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstancesInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstancesOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListNotebookExecutionsInput$Marker' => 'The pagination token, returned by a previous ListNotebookExecutions
call, that indicates the start of the list for this ListNotebookExecutions
call.
A pagination token that a subsequent ListNotebookExecutions
can use to determine the next set of results to retrieve.
The pagination token that indicates the set of results to retrieve.
', 'ListSecurityConfigurationsOutput$Marker' => 'A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.
', 'ListStepsInput$Marker' => 'The maximum number of steps that a single ListSteps
action returns is 50. To return a longer list of steps, use multiple ListSteps
actions along with the Marker
parameter, which is a pagination token that indicates the next set of results to retrieve.
The maximum number of steps that a single ListSteps
action returns is 50. To return a longer list of steps, use multiple ListSteps
actions along with the Marker
parameter, which is a pagination token that indicates the next set of results to retrieve.
The pagination token that indicates the set of results to retrieve.
', 'ListStudioSessionMappingsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListStudiosInput$Marker' => 'The pagination token that indicates the set of results to retrieve.
', 'ListStudiosOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', ], ], 'MarketType' => [ 'base' => NULL, 'refs' => [ 'Instance$Market' => 'The instance purchasing option. Valid values are ON_DEMAND
or SPOT
.
The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
', 'InstanceGroupConfig$Market' => 'Market type of the Amazon EC2 instances used to create a cluster node.
', 'InstanceGroupDetail$Market' => 'Market type of the Amazon EC2 instances used to create a cluster node.
', 'ScalingAction$Market' => 'Not available for instance groups. Instance groups use the market type specified for the group.
', ], ], 'MaxResultsNumber' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelInput$MaxResults' => 'Reserved for future use. Currently set to null.
', 'ListReleaseLabelsInput$MaxResults' => 'Defines the maximum number of release labels to return in a single response. The default is 100
.
A CloudWatch dimension, which is specified using a Key
(known as a Name
in CloudWatch), Value
pair. By default, Amazon EMR uses one dimension whose Key
is JobFlowID
and Value
is a variable representing the cluster ID, which is ${emr.clusterId}
. This enables the rule to bootstrap when the cluster ID becomes available.
A CloudWatch metric dimension.
', ], ], 'ModifyClusterInput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClusterOutput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyInstanceFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyInstanceGroupsInput' => [ 'base' => 'Change the size of some instance groups.
', 'refs' => [], ], 'NewSupportedProductsList' => [ 'base' => NULL, 'refs' => [ 'RunJobFlowInput$NewSupportedProducts' => 'For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.
A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. Supported values are:
"mapr-m3" - launch the cluster using MapR M3 Edition.
"mapr-m5" - launch the cluster using MapR M5 Edition.
"mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.
"mapr-m7" - launch the cluster using MapR M7 Edition.
"hunk" - launch the cluster with the Hunk Big Data Analytics Platform.
"hue"- launch the cluster with Hue installed.
"spark" - launch the cluster with Apache Spark installed.
"ganglia" - launch the cluster with the Ganglia Monitoring System installed.
The value against which the specified statistic is compared.
', 'InstanceTypeConfig$BidPriceAsPercentageOfOnDemandPrice' => 'The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType
. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is provided, BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType
. Expressed as a number (for example, 20 specifies 20%).
A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution
action.
Properties of the notebook execution.
', ], ], 'NotebookExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ListNotebookExecutionsInput$Status' => 'The status filter for listing notebook executions.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
The status of the notebook execution.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
The status of the notebook execution.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.
', 'refs' => [ 'NotebookExecutionSummaryList$member' => NULL, ], ], 'NotebookExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookExecutionsOutput$NotebookExecutions' => 'A list of notebook executions.
', ], ], 'NotebookS3LocationForOutput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution input.
', 'refs' => [ 'NotebookExecution$NotebookS3Location' => 'The Amazon S3 location that stores the notebook execution input.
', 'NotebookExecutionSummary$NotebookS3Location' => 'The Amazon S3 location that stores the notebook execution input.
', ], ], 'NotebookS3LocationFromInput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution input.
', 'refs' => [ 'StartNotebookExecutionInput$NotebookS3Location' => 'The Amazon S3 location for the notebook execution input.
', ], ], 'OSRelease' => [ 'base' => 'The Amazon Linux release specified for a cluster in the RunJobFlow request.
', 'refs' => [ 'OSReleaseList$member' => NULL, ], ], 'OSReleaseList' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelOutput$AvailableOSReleases' => 'The list of available Amazon Linux release versions for an Amazon EMR release. Contains a Label field that is formatted as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
', ], ], 'OnDemandCapacityReservationOptions' => [ 'base' => 'Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
', 'refs' => [ 'OnDemandProvisioningSpecification$CapacityReservationOptions' => 'The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.
', ], ], 'OnDemandCapacityReservationPreference' => [ 'base' => NULL, 'refs' => [ 'OnDemandCapacityReservationOptions$CapacityReservationPreference' => 'Indicates the instance\'s Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first
, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price
) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price
).
If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.
', ], ], 'OnDemandProvisioningAllocationStrategy' => [ 'base' => NULL, 'refs' => [ 'OnDemandProvisioningSpecification$AllocationStrategy' => 'Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is lowest-price
(the default), which launches the lowest price first.
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR releases 5.12.1 and later.
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR releases 5.12.1 and later.
The resize specification for On-Demand Instances in the instance fleet, which contains the resize timeout period.
', 'refs' => [ 'InstanceFleetResizingSpecifications$OnDemandResizeSpecification' => 'The resize specification for On-Demand Instances in the instance fleet, which contains the resize timeout period.
', ], ], 'OptionalArnType' => [ 'base' => NULL, 'refs' => [ 'Cluster$OutpostArn' => 'The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
', 'ClusterSummary$OutpostArn' => 'The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
', 'Step$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
.
For example, arn:aws:IAM::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
The output format for the notebook execution.
', 'StartNotebookExecutionInput$OutputNotebookFormat' => 'The output format for the notebook execution.
', ], ], 'OutputNotebookS3LocationForOutput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution output.
', 'refs' => [ 'NotebookExecution$OutputNotebookS3Location' => 'The Amazon S3 location for the notebook execution output.
', ], ], 'OutputNotebookS3LocationFromInput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution output.
', 'refs' => [ 'StartNotebookExecutionInput$OutputNotebookS3Location' => 'The Amazon S3 location for the notebook execution output.
', ], ], 'PlacementGroupConfig' => [ 'base' => 'Placement group configuration for an Amazon EMR cluster. The configuration specifies the placement strategy that can be applied to instance roles during cluster creation.
To use this configuration, consider attaching managed policy AmazonElasticMapReducePlacementGroupPolicy to the Amazon EMR role.
', 'refs' => [ 'PlacementGroupConfigList$member' => NULL, ], ], 'PlacementGroupConfigList' => [ 'base' => NULL, 'refs' => [ 'Cluster$PlacementGroups' => 'Placement group configured for an Amazon EMR cluster.
', 'RunJobFlowInput$PlacementGroupConfigs' => 'The specified placement group configuration for an Amazon EMR cluster.
', ], ], 'PlacementGroupStrategy' => [ 'base' => NULL, 'refs' => [ 'PlacementGroupConfig$PlacementStrategy' => 'Amazon EC2 Placement Group strategy associated with instance role.
Starting with Amazon EMR release 5.23.0, the only supported placement strategy is SPREAD
for the MASTER
instance role.
The Amazon EC2 Availability Zone configuration of the cluster (job flow).
', 'refs' => [ 'JobFlowInstancesConfig$Placement' => 'The Availability Zone in which the cluster runs.
', 'JobFlowInstancesDetail$Placement' => 'The Amazon EC2 Availability Zone for the cluster.
', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'PortRange$MinRange' => 'The smallest port number in a specified range of port numbers.
', 'PortRange$MaxRange' => 'The smallest port number in a specified range of port numbers.
', ], ], 'PortRange' => [ 'base' => 'A list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify a single port, use the same value for MinRange
and MaxRange
.
Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges
, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source.
By default, Port 22, which is used for SSH access to the cluster Amazon EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges
.
Type of reconfiguration requested. Valid values are MERGE and OVERWRITE.
', ], ], 'ReleaseLabelFilter' => [ 'base' => 'The release label filters by application or version prefix.
', 'refs' => [ 'ListReleaseLabelsInput$Filters' => 'Filters the results of the request. Prefix
specifies the prefix of release labels to return. Application
specifies the application (with/without version) of release labels to return.
This input identifies an Amazon EMR resource and a list of tags to remove.
', 'refs' => [], ], 'RemoveTagsOutput' => [ 'base' => 'This output indicates the result of removing tags from the resource.
', 'refs' => [], ], 'RepoUpgradeOnBoot' => [ 'base' => NULL, 'refs' => [ 'Cluster$RepoUpgradeOnBoot' => 'Applies only when CustomAmiID
is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.
Applies only when CustomAmiID
is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY
, which indicates that only security updates are applied. If NONE
is specified, no updates are applied, and all updates must be applied manually.
The Amazon EMR resource identifier to which tags will be added. For example, a cluster identifier or an Amazon EMR Studio ID.
', 'RemoveTagsInput$ResourceId' => 'The Amazon EMR resource identifier from which tags will be removed. For example, a cluster identifier or an Amazon EMR Studio ID.
', ], ], 'RunJobFlowInput' => [ 'base' => 'Input to the RunJobFlow operation.
', 'refs' => [], ], 'RunJobFlowOutput' => [ 'base' => 'The result of the RunJobFlow operation.
', 'refs' => [], ], 'ScaleDownBehavior' => [ 'base' => NULL, 'refs' => [ 'Cluster$ScaleDownBehavior' => 'The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
', 'refs' => [ 'ScalingRule$Action' => 'The conditions that trigger an automatic scaling activity.
', ], ], 'ScalingConstraints' => [ 'base' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits.
', 'refs' => [ 'AutoScalingPolicy$Constraints' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
', 'AutoScalingPolicyDescription$Constraints' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
', ], ], 'ScalingRule' => [ 'base' => 'A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how Amazon EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.
', 'refs' => [ 'ScalingRuleList$member' => NULL, ], ], 'ScalingRuleList' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicy$Rules' => 'The scale-in and scale-out rules that comprise the automatic scaling policy.
', 'AutoScalingPolicyDescription$Rules' => 'The scale-in and scale-out rules that comprise the automatic scaling policy.
', ], ], 'ScalingTrigger' => [ 'base' => 'The conditions that trigger an automatic scaling activity.
', 'refs' => [ 'ScalingRule$Trigger' => 'The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
', ], ], 'ScriptBootstrapActionConfig' => [ 'base' => 'Configuration of the script to run during a bootstrap action.
', 'refs' => [ 'BootstrapActionConfig$ScriptBootstrapAction' => 'The script run by the bootstrap action.
', ], ], 'SecurityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListSecurityConfigurationsOutput$SecurityConfigurations' => 'The creation date and time, and name, of each security configuration.
', ], ], 'SecurityConfigurationSummary' => [ 'base' => 'The creation date and time, and name, of a security configuration.
', 'refs' => [ 'SecurityConfigurationList$member' => NULL, ], ], 'SecurityGroupsList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesConfig$AdditionalMasterSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the master node.
', 'JobFlowInstancesConfig$AdditionalSlaveSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the core and task nodes.
', ], ], 'SessionMappingDetail' => [ 'base' => 'Details for an Amazon EMR Studio session mapping including creation time, user or group ID, Studio ID, and so on.
', 'refs' => [ 'GetStudioSessionMappingOutput$SessionMapping' => 'The session mapping details for the specified Amazon EMR Studio and identity, including session policy ARN and creation time.
', ], ], 'SessionMappingSummary' => [ 'base' => 'Details for an Amazon EMR Studio session mapping. The details do not include the time the session mapping was last modified.
', 'refs' => [ 'SessionMappingSummaryList$member' => NULL, ], ], 'SessionMappingSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStudioSessionMappingsOutput$SessionMappings' => 'A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Amazon EMR Studio ID.
', ], ], 'SetKeepJobFlowAliveWhenNoStepsInput' => [ 'base' => NULL, 'refs' => [], ], 'SetTerminationProtectionInput' => [ 'base' => 'The input argument to the TerminationProtection operation.
', 'refs' => [], ], 'SetUnhealthyNodeReplacementInput' => [ 'base' => NULL, 'refs' => [], ], 'SetVisibleToAllUsersInput' => [ 'base' => 'The input to the SetVisibleToAllUsers action.
', 'refs' => [], ], 'ShrinkPolicy' => [ 'base' => 'Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.
', 'refs' => [ 'InstanceGroup$ShrinkPolicy' => 'Policy for customizing shrink operations.
', 'InstanceGroupModifyConfig$ShrinkPolicy' => 'Policy for customizing shrink operations.
', ], ], 'SimpleScalingPolicyConfiguration' => [ 'base' => 'An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of Amazon EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.
', 'refs' => [ 'ScalingAction$SimpleScalingPolicyConfiguration' => 'The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
', ], ], 'SimplifiedApplication' => [ 'base' => 'The returned release label application names or versions.
', 'refs' => [ 'SimplifiedApplicationList$member' => NULL, ], ], 'SimplifiedApplicationList' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelOutput$Applications' => 'The list of applications available for the target release label. Name
is the name of the application. Version
is the concise version of the application.
Specifies one of the following strategies to launch Spot Instance fleets: price-capacity-optimized
, capacity-optimized
, lowest-price
, or diversified
. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.
When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized
strategy. You can\'t change the allocation strategy from the old console.
The launch specification for Spot Instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is available in Amazon EMR releases 5.12.1 and later.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
', ], ], 'SpotProvisioningTimeoutAction' => [ 'base' => NULL, 'refs' => [ 'SpotProvisioningSpecification$TimeoutAction' => 'The action to take when TargetSpotCapacity
has not been fulfilled when the TimeoutDurationMinutes
has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER
and SWITCH_TO_ON_DEMAND
. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
The resize specification for Spot Instances in the instance fleet, which contains the resize timeout period.
', 'refs' => [ 'InstanceFleetResizingSpecifications$SpotResizeSpecification' => 'The resize specification for Spot Instances in the instance fleet, which contains the resize timeout period.
', ], ], 'StartNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$Statistic' => 'The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
This represents a step in a cluster.
', 'refs' => [ 'DescribeStepOutput$Step' => 'The step details for the requested step identifier.
', ], ], 'StepCancellationOption' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInput$StepCancellationOption' => 'The option to choose to cancel RUNNING
steps. By default, the value is SEND_INTERRUPT
.
Specification for a cluster (job flow) step.
', 'refs' => [ 'StepConfigList$member' => NULL, 'StepDetail$StepConfig' => 'The step configuration.
', ], ], 'StepConfigList' => [ 'base' => NULL, 'refs' => [ 'AddJobFlowStepsInput$Steps' => 'A list of StepConfig to be executed by the job flow.
', 'RunJobFlowInput$Steps' => 'A list of steps to run.
', ], ], 'StepDetail' => [ 'base' => 'Combines the execution state and configuration of a step.
', 'refs' => [ 'StepDetailList$member' => NULL, ], ], 'StepDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$Steps' => 'A list of steps run by the job flow.
', ], ], 'StepExecutionState' => [ 'base' => NULL, 'refs' => [ 'StepExecutionStatusDetail$State' => 'The state of the step.
', ], ], 'StepExecutionStatusDetail' => [ 'base' => 'The execution state of a step.
', 'refs' => [ 'StepDetail$ExecutionStatusDetail' => 'The description of the step status.
', ], ], 'StepId' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInfo$StepId' => 'The encrypted StepId of a step.
', 'DescribeStepInput$StepId' => 'The identifier of the step to describe.
', 'Step$Id' => 'The identifier of the cluster step.
', 'StepSummary$Id' => 'The identifier of the cluster step.
', ], ], 'StepIdsList' => [ 'base' => NULL, 'refs' => [ 'AddJobFlowStepsOutput$StepIds' => 'The identifiers of the list of steps added to the job flow.
', 'CancelStepsInput$StepIds' => 'The list of StepIDs
to cancel. Use ListSteps to get steps and their states for the specified cluster.
The execution state of the cluster step.
', ], ], 'StepStateChangeReason' => [ 'base' => 'The details of the step state change reason.
', 'refs' => [ 'StepStatus$StateChangeReason' => 'The reason for the step execution status change.
', ], ], 'StepStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'StepStateChangeReason$Code' => 'The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.
', ], ], 'StepStateList' => [ 'base' => NULL, 'refs' => [ 'ListStepsInput$StepStates' => 'The filter to limit the step list based on certain states.
', ], ], 'StepStatus' => [ 'base' => 'The execution status details of the cluster step.
', 'refs' => [ 'Step$Status' => 'The current execution status details of the cluster step.
', 'StepSummary$Status' => 'The current execution status details of the cluster step.
', ], ], 'StepSummary' => [ 'base' => 'The summary of the cluster step.
', 'refs' => [ 'StepSummaryList$member' => NULL, ], ], 'StepSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStepsOutput$Steps' => 'The filtered list of steps for the cluster.
', ], ], 'StepTimeline' => [ 'base' => 'The timeline of the cluster step lifecycle.
', 'refs' => [ 'StepStatus$Timeline' => 'The timeline of the cluster step status over time.
', ], ], 'StopNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Application$Name' => 'The name of the application.
', 'Application$Version' => 'The version of the application.
', 'AutoScalingPolicyStateChangeReason$Message' => 'A friendly, more verbose message that accompanies an automatic scaling policy state change.
', 'CancelStepsInfo$Reason' => 'The reason for the failure if the CancelSteps request fails.
', 'CloudWatchAlarmDefinition$MetricName' => 'The name of the CloudWatch metric that is watched to determine an alarm condition.
', 'CloudWatchAlarmDefinition$Namespace' => 'The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce
.
The name of the cluster. This parameter can\'t contain the characters <, >, $, |, or ` (backtick).
', 'Cluster$LogUri' => 'The path to the Amazon S3 location where logs for this cluster are stored.
', 'Cluster$LogEncryptionKmsKeyId' => 'The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.
', 'Cluster$RequestedAmiVersion' => 'The AMI version requested for this cluster.
', 'Cluster$RunningAmiVersion' => 'The AMI version running on this cluster.
', 'Cluster$ReleaseLabel' => 'The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x
, where x.x.x is an Amazon EMR release version such as emr-5.14.0
. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion
.
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
', 'Cluster$MasterPublicDnsName' => 'The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
', 'Cluster$OSReleaseLabel' => 'The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.
', 'ClusterStateChangeReason$Message' => 'The descriptive message for the state change reason.
', 'ClusterSummary$Name' => 'The name of the cluster.
', 'Command$Name' => 'The name of the command.
', 'Command$ScriptPath' => 'The Amazon S3 location of the command script.
', 'Configuration$Classification' => 'The classification within a configuration.
', 'CreateSecurityConfigurationInput$SecurityConfiguration' => 'The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
', 'DescribeReleaseLabelInput$ReleaseLabel' => 'The target release label to be described.
', 'DescribeReleaseLabelInput$NextToken' => 'The pagination token. Reserved for future use. Currently set to null.
', 'DescribeReleaseLabelOutput$ReleaseLabel' => 'The target release label described in the response.
', 'DescribeReleaseLabelOutput$NextToken' => 'The pagination token. Reserved for future use. Currently set to null.
', 'DescribeSecurityConfigurationOutput$SecurityConfiguration' => 'The security configuration details in JSON format.
', 'EbsBlockDevice$Device' => 'The device name that is exposed to the instance, such as /dev/sdh.
', 'EbsVolume$Device' => 'The device name that is exposed to the instance, such as /dev/sdh.
', 'EbsVolume$VolumeId' => 'The volume identifier of the EBS volume.
', 'Ec2InstanceAttributes$Ec2KeyName' => 'The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
', 'Ec2InstanceAttributes$Ec2SubnetId' => 'Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.
', 'Ec2InstanceAttributes$Ec2AvailabilityZone' => 'The Availability Zone in which the cluster will run.
', 'Ec2InstanceAttributes$IamInstanceProfile' => 'The IAM role that was specified when the cluster was launched. The Amazon EC2 instances of the cluster assume this role.
', 'Ec2InstanceAttributes$EmrManagedMasterSecurityGroup' => 'The identifier of the Amazon EC2 security group for the master node.
', 'Ec2InstanceAttributes$EmrManagedSlaveSecurityGroup' => 'The identifier of the Amazon EC2 security group for the core and task nodes.
', 'Ec2InstanceAttributes$ServiceAccessSecurityGroup' => 'The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
', 'ErrorDetail$ErrorCode' => 'The name or code associated with the error.
', 'ErrorDetail$ErrorMessage' => 'A message that describes the error.
', 'FailureDetails$Reason' => 'The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.
', 'FailureDetails$Message' => 'The descriptive message including the error the Amazon EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.
', 'FailureDetails$LogFile' => 'The path to the log file where the step failure root cause was originally recorded.
', 'HadoopStepConfig$Jar' => 'The path to the JAR file that runs during the step.
', 'HadoopStepConfig$MainClass' => 'The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
', 'Instance$PublicDnsName' => 'The public DNS name of the instance.
', 'Instance$PublicIpAddress' => 'The public IP address of the instance.
', 'Instance$PrivateDnsName' => 'The private DNS name of the instance.
', 'Instance$PrivateIpAddress' => 'The private IP address of the instance.
', 'Instance$InstanceGroupId' => 'The identifier of the instance group to which this instance belongs.
', 'InstanceFleetStateChangeReason$Message' => 'An explanatory message.
', 'InstanceGroup$Name' => 'The name of the instance group.
', 'InstanceGroup$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
The status change reason description.
', 'InstanceStateChangeReason$Message' => 'The status change reason description.
', 'ListReleaseLabelsInput$NextToken' => 'Specifies the next page of results. If NextToken
is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The ListReleaseLabels
request fails if the identity (Amazon Web Services account ID) and all filtering parameters are different from the original request, or if the NextToken
is expired or tampered with.
Used to paginate the next page of results if specified in the next ListReleaseLabels
request.
The Amazon EMR release label determines the versions of open-source application packages that Amazon EMR has installed on the cluster. Release labels are in the format emr-x.x.x
, where x.x.x is an Amazon EMR release number such as emr-6.10.0
. For more information about Amazon EMR releases and their included application versions and features, see the Amazon EMR Release Guide .
The pagination token that marks the next set of results to retrieve.
', 'ListSupportedInstanceTypesOutput$Marker' => 'The pagination token that marks the next set of results to retrieve.
', 'MetricDimension$Key' => 'The dimension name.
', 'MetricDimension$Value' => 'The dimension value.
', 'ModifyClusterInput$ClusterId' => 'The unique identifier of the cluster.
', 'OSRelease$Label' => 'The Amazon Linux release specified for a cluster in the RunJobFlow request. The format is as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
', 'ReleaseLabelFilter$Prefix' => 'Optional release label version prefix filter. For example, emr-5
.
Optional release label application filter. For example, spark@2.1.0
.
The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
', 'ScalingRule$Description' => 'A friendly, more verbose description of the automatic scaling rule.
', 'SimplifiedApplication$Name' => 'The returned release label application name. For example, hadoop
.
The returned release label application version. For example, 3.2.1
.
The name of the cluster step.
', 'StepStateChangeReason$Message' => 'The descriptive message for the state change reason.
', 'StepSummary$Name' => 'The name of the cluster step.
', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubnetIdList$member' => NULL, 'SupportedInstanceType$Type' => 'The Amazon EC2 instance type, for example m5.xlarge
, of the SupportedInstanceType
.
The Amazon EC2 family and generation for the SupportedInstanceType
.
The CPU architecture, for example X86_64
or AARCH64
.
A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag.
', 'Tag$Value' => 'A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
', 'VolumeSpecification$VolumeType' => 'The volume type. Volume types supported are gp3, gp2, io1, st1, sc1, and standard.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'Application$Args' => 'Arguments for Amazon EMR to pass to the application.
', 'Command$Args' => 'Arguments for Amazon EMR to pass to the command for execution.
', 'Ec2InstanceAttributes$AdditionalMasterSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the master node.
', 'Ec2InstanceAttributes$AdditionalSlaveSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the core and task nodes.
', 'HadoopStepConfig$Args' => 'The list of command line arguments to pass to the JAR file\'s main function for execution.
', 'ListReleaseLabelsOutput$ReleaseLabels' => 'The returned release labels.
', 'RemoveTagsInput$TagKeys' => 'A list of tag keys to remove from the resource.
', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'Application$AdditionalInfo' => 'This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
', 'Configuration$Properties' => 'A set of properties specified within a configuration classification.
', 'ErrorData$member' => NULL, 'HadoopStepConfig$Properties' => 'The list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.
', ], ], 'Studio' => [ 'base' => 'Details for an Amazon EMR Studio including ID, creation time, name, and so on.
', 'refs' => [ 'DescribeStudioOutput$Studio' => 'The Amazon EMR Studio details.
', ], ], 'StudioSummary' => [ 'base' => 'Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. To fetch additional details such as subnets, IAM roles, security groups, and tags for the Studio, use the DescribeStudio API.
', 'refs' => [ 'StudioSummaryList$member' => NULL, ], ], 'StudioSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStudiosOutput$Studios' => 'The list of Studio summary objects.
', ], ], 'SubnetIdList' => [ 'base' => NULL, 'refs' => [ 'CreateStudioInput$SubnetIds' => 'A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId
. Studio users can create a Workspace in any of the specified subnets.
The list of IDs of the subnets associated with the Amazon EMR Studio.
', 'UpdateStudioInput$SubnetIds' => 'A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio.
', ], ], 'SupportedInstanceType' => [ 'base' => 'An instance type that the specified Amazon EMR release supports.
', 'refs' => [ 'SupportedInstanceTypesList$member' => NULL, ], ], 'SupportedInstanceTypesList' => [ 'base' => NULL, 'refs' => [ 'ListSupportedInstanceTypesOutput$SupportedInstanceTypes' => 'The list of instance types that the release specified in ListSupportedInstanceTypesInput$ReleaseLabel
supports, filtered by Amazon Web Services Region.
The list of supported product configurations that allow user-supplied arguments. Amazon EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.
', 'refs' => [ 'NewSupportedProductsList$member' => NULL, ], ], 'SupportedProductsList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$SupportedProducts' => 'A list of strings set by third-party software when the job flow is launched. If you are not using third-party software to manage the job flow, this value is empty.
', 'RunJobFlowInput$SupportedProducts' => 'For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.
A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:
"mapr-m3" - launch the job flow using MapR M3 Edition.
"mapr-m5" - launch the job flow using MapR M5 Edition.
A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$Tags' => 'A list of tags to associate with a resource. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
', 'Cluster$Tags' => 'A list of tags associated with a cluster.
', 'CreateStudioInput$Tags' => 'A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
', 'NotebookExecution$Tags' => 'A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
', 'RunJobFlowInput$Tags' => 'A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
', 'StartNotebookExecutionInput$Tags' => 'A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
', 'Studio$Tags' => 'A list of tags associated with the Amazon EMR Studio.
', ], ], 'TerminateJobFlowsInput' => [ 'base' => 'Input to the TerminateJobFlows operation.
', 'refs' => [], ], 'ThroughputVal' => [ 'base' => NULL, 'refs' => [ 'VolumeSpecification$Throughput' => 'The throughput, in mebibyte per second (MiB/s). This optional parameter can be a number from 125 - 1000 and is valid only for gp3 volumes.
', ], ], 'Unit' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$Unit' => 'The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit
must correspond to the units specified in the CloudWatch metric.
The key to the Amazon S3 location that stores the notebook execution input.
', 'NotebookS3LocationFromInput$Key' => 'The key to the Amazon S3 location that stores the notebook execution input.
', 'OutputNotebookS3LocationForOutput$Key' => 'The key to the Amazon S3 location that stores the notebook execution output.
', 'OutputNotebookS3LocationFromInput$Key' => 'The key to the Amazon S3 location that stores the notebook execution output.
', ], ], 'UsernamePassword' => [ 'base' => 'The username and password that you use to connect to cluster endpoints.
', 'refs' => [ 'Credentials$UsernamePassword' => 'The username and password that you use to connect to cluster endpoints.
', ], ], 'VolumeSpecification' => [ 'base' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', 'refs' => [ 'EbsBlockDevice$VolumeSpecification' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', 'EbsBlockDeviceConfig$VolumeSpecification' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', ], ], 'WholeNumber' => [ 'base' => NULL, 'refs' => [ 'InstanceFleet$TargetOnDemandCapacity' => 'The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When an On-Demand Instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.
If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity
. At least one of TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be 1.
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When a Spot instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.
If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be 1.
The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity
. This provisioned capacity might be less than or greater than TargetOnDemandCapacity
.
The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity
. This provisioned capacity might be less than or greater than TargetSpotCapacity
.
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When an On-Demand Instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity
. At least one of TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be 1.
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When a Spot Instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be 1.
The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.
', 'InstanceFleetModifyConfig$TargetSpotCapacity' => 'The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.
', 'InstanceTypeConfig$WeightedCapacity' => 'The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.
', 'InstanceTypeSpecification$WeightedCapacity' => 'The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.
', 'OnDemandResizingSpecification$TimeoutDurationMinutes' => 'On-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
', 'SpotProvisioningSpecification$TimeoutDurationMinutes' => 'The Spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction
is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
Spot resize timeout in minutes. If Spot Instances are not provisioned within this time, the resize workflow will stop provisioning of Spot instances. Minimum value is 5 minutes and maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
', ], ], 'XmlString' => [ 'base' => NULL, 'refs' => [ 'Cluster$SecurityConfiguration' => 'The name of the security configuration applied to the cluster.
', 'Cluster$AutoScalingRole' => 'An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
The name of the security configuration.
', 'CreateSecurityConfigurationOutput$Name' => 'The name of the security configuration.
', 'CreateStudioInput$ServiceRole' => 'The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
', 'CreateStudioInput$UserRole' => 'The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole
when you use IAM Identity Center authentication. The permissions attached to the UserRole
can be scoped down for each user or group using session policies.
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
', 'CreateStudioInput$IdpAuthUrl' => 'The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
', 'CreateStudioInput$EncryptionKeyArn' => 'The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
', 'CreateStudioOutput$Url' => 'The unique Studio access URL.
', 'DeleteSecurityConfigurationInput$Name' => 'The name of the security configuration.
', 'DescribeSecurityConfigurationInput$Name' => 'The name of the security configuration.
', 'DescribeSecurityConfigurationOutput$Name' => 'The name of the security configuration.
', 'EnvironmentVariablesMap$value' => NULL, 'HadoopJarStepConfig$Jar' => 'A path to a JAR file run during the step.
', 'HadoopJarStepConfig$MainClass' => 'The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
', 'InstanceGroupDetail$LastStateChangeReason' => 'Details regarding the state of the instance group.
', 'JobFlowDetail$LogUri' => 'The location in Amazon S3 where log files for the job are stored.
', 'JobFlowDetail$LogEncryptionKmsKeyId' => 'The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding 6.0.0.
', 'JobFlowDetail$JobFlowRole' => 'The IAM role that was specified when the job flow was launched. The Amazon EC2 instances of the job flow assume this role.
', 'JobFlowDetail$ServiceRole' => 'The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.
', 'JobFlowDetail$AutoScalingRole' => 'An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate Amazon EC2 instances in an instance group.
Description of the job flow last changed state.
', 'JobFlowInstancesDetail$MasterPublicDnsName' => 'The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
', 'JobFlowInstancesDetail$MasterInstanceId' => 'The Amazon EC2 instance identifier of the master node.
', 'KeyValue$Key' => 'The unique identifier of a key-value pair.
', 'KeyValue$Value' => 'The value part of the identified key.
', 'ListNotebookExecutionsInput$ExecutionEngineId' => 'The unique ID of the execution engine.
', 'NotebookExecution$NotebookParams' => 'Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
', 'NotebookExecution$OutputNotebookURI' => 'The location of the notebook execution\'s output file in Amazon S3.
', 'NotebookExecution$LastStateChangeReason' => 'The reason for the latest status change of the notebook execution.
', 'NotebookExecutionSummary$ExecutionEngineId' => 'The unique ID of the execution engine for the notebook execution.
', 'PlacementType$AvailabilityZone' => 'The Amazon EC2 Availability Zone for the cluster. AvailabilityZone
is used for uniform instance groups, while AvailabilityZones
(plural) is used for instance fleets.
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
', 'RunJobFlowInput$LogEncryptionKmsKeyId' => 'The KMS key used for encrypting log files. If a value is not provided, the logs remain encrypted by AES-256. This attribute is only available with Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
', 'RunJobFlowInput$AdditionalInfo' => 'A JSON string for selecting additional features.
', 'RunJobFlowInput$JobFlowRole' => 'Also called instance profile and Amazon EC2 role. An IAM role for an Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole
. In order to use the default role, you must have already created it using the CLI or console.
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf. If you\'ve created a custom service role path, you must specify it for the service role when you launch your cluster.
', 'RunJobFlowInput$SecurityConfiguration' => 'The name of a security configuration to apply to the cluster.
', 'RunJobFlowInput$AutoScalingRole' => 'An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
Location in Amazon S3 of the script to run during a bootstrap action.
', 'SecurityConfigurationSummary$Name' => 'The name of the security configuration.
', 'StartNotebookExecutionInput$RelativePath' => 'The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks
when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD
(the EditorID
of this request), and you specify a RelativePath
of my_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
', 'StartNotebookExecutionInput$ServiceRole' => 'The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
', 'StepExecutionStatusDetail$LastStateChangeReason' => 'A description of the step\'s current state.
', 'Studio$ServiceRole' => 'The name of the IAM role assumed by the Amazon EMR Studio.
', 'Studio$UserRole' => 'The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole
when you use IAM authentication.
The unique access URL of the Amazon EMR Studio.
', 'Studio$DefaultS3Location' => 'The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
', 'Studio$IdpAuthUrl' => 'Your identity provider\'s authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
', 'Studio$EncryptionKeyArn' => 'The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
', 'UpdateStudioInput$DefaultS3Location' => 'The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.
', 'UpdateStudioInput$EncryptionKeyArn' => 'The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
', 'XmlStringList$member' => NULL, ], ], 'XmlStringList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsInput$JobFlowIds' => 'Return only job flows whose job flow ID is contained in this list.
', 'HadoopJarStepConfig$Args' => 'A list of command line arguments passed to the JAR file\'s main function when executed.
', 'ListStepsInput$StepIds' => 'The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.
', 'ScriptBootstrapActionConfig$Args' => 'A list of command line arguments to pass to the bootstrap action script.
', 'SetKeepJobFlowAliveWhenNoStepsInput$JobFlowIds' => 'A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows.
', 'SetTerminationProtectionInput$JobFlowIds' => 'A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
', 'SetUnhealthyNodeReplacementInput$JobFlowIds' => 'The list of strings that uniquely identify the clusters for which to turn on unhealthy node replacement. You can get these identifiers by running the RunJobFlow or the DescribeJobFlows operations.
', 'SetVisibleToAllUsersInput$JobFlowIds' => 'The unique identifier of the job flow (cluster).
', 'SupportedProductConfig$Args' => 'The list of user-supplied arguments.
', 'TerminateJobFlowsInput$JobFlowIds' => 'A list of job flows to be shut down.
', ], ], 'XmlStringMaxLen256' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetInput$ClusterId' => 'The unique identifier of the cluster.
', 'AddInstanceFleetOutput$ClusterId' => 'The unique identifier of the cluster.
', 'AddInstanceGroupsInput$JobFlowId' => 'Job flow in which to add the instance groups.
', 'AddInstanceGroupsOutput$JobFlowId' => 'The job flow ID in which the instance groups are added.
', 'AddJobFlowStepsInput$JobFlowId' => 'A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.
', 'BootstrapActionConfig$Name' => 'The name of the bootstrap action.
', 'CancelStepsInput$ClusterId' => 'The ClusterID
for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
', 'CreateStudioInput$Name' => 'A descriptive name for the Amazon EMR Studio.
', 'CreateStudioInput$Description' => 'A detailed description of the Amazon EMR Studio.
', 'CreateStudioInput$VpcId' => 'The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
', 'CreateStudioInput$WorkspaceSecurityGroupId' => 'The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId
.
The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId
.
The name that your identity provider (IdP) uses for its RelayState
parameter. For example, RelayState
or TargetSource
. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState
parameter differs by IdP.
The ID of the Amazon EMR Studio.
', 'CreateStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio to which the user or group will be mapped.
', 'CreateStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified, but not both.
The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified, but not both.
The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an Amazon EMR Studio User Role with Session Policies.
', 'DeleteStudioInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'DeleteStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'DeleteStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
The name of the user name or group to remove from the Amazon EMR Studio. For more information, see UserName and DisplayName in the IAM Identity Center Store API Reference. Either IdentityName
or IdentityId
must be specified.
The unique identifier of the notebook execution.
', 'DescribeStudioInput$StudioId' => 'The Amazon EMR Studio ID.
', 'EnvironmentVariablesMap$key' => NULL, 'ExecutionEngineConfig$Id' => 'The unique identifier of the execution engine. For an Amazon EMR cluster, this is the cluster ID.
', 'ExecutionEngineConfig$MasterInstanceSecurityGroupId' => 'An optional unique ID of an Amazon EC2 security group to associate with the master instance of the Amazon EMR cluster for this notebook execution. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the EMR Management Guide.
', 'GetClusterSessionCredentialsInput$ClusterId' => 'The unique identifier of the cluster.
', 'GetStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'GetStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
The name of the user or group to fetch. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
A friendly name for the instance fleet.
', 'InstanceFleetConfig$Name' => 'The friendly name of the instance fleet.
', 'InstanceGroup$CustomAmiId' => 'The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupConfig$Name' => 'Friendly name given to the instance group.
', 'InstanceGroupConfig$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupDetail$InstanceGroupId' => 'Unique identifier for the instance group.
', 'InstanceGroupDetail$Name' => 'Friendly name for the instance group.
', 'InstanceGroupDetail$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupIdsList$member' => NULL, 'InstanceGroupModifyConfig$InstanceGroupId' => 'Unique ID of the instance group to modify.
', 'InstanceTypeConfig$BidPrice' => 'The bid price for each Amazon EC2 Spot Instance type as defined by InstanceType
. Expressed in USD. If neither BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is provided, BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The custom AMI ID to use for the instance type.
', 'InstanceTypeSpecification$BidPrice' => 'The bid price for each Amazon EC2 Spot Instance type as defined by InstanceType
. Expressed in USD.
The custom AMI ID to use for the instance type.
', 'JobFlowDetail$JobFlowId' => 'The job flow identifier.
', 'JobFlowDetail$Name' => 'The name of the job flow.
', 'JobFlowDetail$AmiVersion' => 'Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
The name of the Amazon EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop."
', 'JobFlowInstancesConfig$HadoopVersion' => 'Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion
parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.
', 'JobFlowInstancesConfig$EmrManagedMasterSecurityGroup' => 'The identifier of the Amazon EC2 security group for the master node. If you specify EmrManagedMasterSecurityGroup
, you must also specify EmrManagedSlaveSecurityGroup
.
The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup
, you must also specify EmrManagedMasterSecurityGroup
.
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
', 'JobFlowInstancesDetail$Ec2KeyName' => 'The name of an Amazon EC2 key pair that can be used to connect to the master node using SSH.
', 'JobFlowInstancesDetail$Ec2SubnetId' => 'For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.
', 'JobFlowInstancesDetail$HadoopVersion' => 'The Hadoop version for the cluster.
', 'KerberosAttributes$Realm' => 'The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL
.
The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.
', 'KerberosAttributes$CrossRealmTrustPrincipalPassword' => 'Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.
', 'KerberosAttributes$ADDomainJoinUser' => 'Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.
', 'KerberosAttributes$ADDomainJoinPassword' => 'The Active Directory password for ADDomainJoinUser
.
The unique ID of the editor associated with the notebook execution.
', 'ListStudioSessionMappingsInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'NotebookExecution$NotebookExecutionId' => 'The unique identifier of a notebook execution.
', 'NotebookExecution$EditorId' => 'The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
', 'NotebookExecution$NotebookExecutionName' => 'A name for the notebook execution.
', 'NotebookExecution$Arn' => 'The Amazon Resource Name (ARN) of the notebook execution.
', 'NotebookExecution$NotebookInstanceSecurityGroupId' => 'The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
', 'NotebookExecutionSummary$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'NotebookExecutionSummary$EditorId' => 'The unique identifier of the editor associated with the notebook execution.
', 'NotebookExecutionSummary$NotebookExecutionName' => 'The name of the notebook execution.
', 'NotebookS3LocationForOutput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution input.
', 'NotebookS3LocationFromInput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution input.
', 'OnDemandCapacityReservationOptions$CapacityReservationResourceGroupArn' => 'The ARN of the Capacity Reservation resource group in which to run the instance.
', 'OutputNotebookS3LocationForOutput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution output.
', 'OutputNotebookS3LocationFromInput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution output.
', 'RunJobFlowInput$Name' => 'The name of the job flow.
', 'RunJobFlowInput$AmiVersion' => 'Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x
, where x.x.x is an Amazon EMR release version such as emr-5.14.0
. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion
.
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster Amazon EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel
specified. For Amazon EMR releases 2.x and 3.x, use AmiVersion
instead.
For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.
', 'RunJobFlowInput$OSReleaseLabel' => 'Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.
', 'RunJobFlowOutput$JobFlowId' => 'A unique identifier for the job flow.
', 'SecurityGroupsList$member' => NULL, 'SessionMappingDetail$StudioId' => 'The ID of the Amazon EMR Studio.
', 'SessionMappingDetail$IdentityId' => 'The globally unique identifier (GUID) of the user or group.
', 'SessionMappingDetail$IdentityName' => 'The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.
', 'SessionMappingDetail$SessionPolicyArn' => 'The Amazon Resource Name (ARN) of the session policy associated with the user or group.
', 'SessionMappingSummary$StudioId' => 'The ID of the Amazon EMR Studio.
', 'SessionMappingSummary$IdentityId' => 'The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store.
', 'SessionMappingSummary$IdentityName' => 'The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.
', 'SessionMappingSummary$SessionPolicyArn' => 'The Amazon Resource Name (ARN) of the session policy associated with the user or group.
', 'StartNotebookExecutionInput$EditorId' => 'The unique identifier of the Amazon EMR Notebook to use for notebook execution.
', 'StartNotebookExecutionInput$NotebookExecutionName' => 'An optional name for the notebook execution.
', 'StartNotebookExecutionInput$NotebookInstanceSecurityGroupId' => 'The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
', 'StartNotebookExecutionOutput$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'StepConfig$Name' => 'The name of the step.
', 'StepIdsList$member' => NULL, 'StopNotebookExecutionInput$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'Studio$StudioId' => 'The ID of the Amazon EMR Studio.
', 'Studio$StudioArn' => 'The Amazon Resource Name (ARN) of the Amazon EMR Studio.
', 'Studio$Name' => 'The name of the Amazon EMR Studio.
', 'Studio$Description' => 'The detailed description of the Amazon EMR Studio.
', 'Studio$VpcId' => 'The ID of the VPC associated with the Amazon EMR Studio.
', 'Studio$WorkspaceSecurityGroupId' => 'The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
', 'Studio$EngineSecurityGroupId' => 'The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.
', 'Studio$IdpRelayStateParameterName' => 'The name of your identity provider\'s RelayState
parameter.
The ID of the Amazon EMR Studio.
', 'StudioSummary$Name' => 'The name of the Amazon EMR Studio.
', 'StudioSummary$VpcId' => 'The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.
', 'StudioSummary$Description' => 'The detailed description of the Amazon EMR Studio.
', 'StudioSummary$Url' => 'The unique access URL of the Amazon EMR Studio.
', 'SupportedProductConfig$Name' => 'The name of the product configuration.
', 'SupportedProductsList$member' => NULL, 'UpdateStudioInput$StudioId' => 'The ID of the Amazon EMR Studio to update.
', 'UpdateStudioInput$Name' => 'A descriptive name for the Amazon EMR Studio.
', 'UpdateStudioInput$Description' => 'A detailed description to assign to the Amazon EMR Studio.
', 'UpdateStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'UpdateStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
The name of the user or group to update. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
The Amazon Resource Name (ARN) of the session policy to associate with the specified user or group.
', 'UsernamePassword$Username' => 'The username associated with the temporary credentials that you use to connect to cluster endpoints.
', 'UsernamePassword$Password' => 'The password associated with the temporary credentials that you use to connect to cluster endpoints.
', 'XmlStringMaxLen256List$member' => NULL, ], ], 'XmlStringMaxLen256List' => [ 'base' => NULL, 'refs' => [ 'Ec2InstanceAttributes$RequestedEc2SubnetIds' => 'Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the Amazon EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds
, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones
instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot be specified together.
Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch Amazon EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones
, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot be specified together.
Applies to clusters that use the instance fleet configuration. When multiple Amazon EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones
is used for instance fleets, while AvailabilityZone
(singular) is used for uniform instance groups.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Amazon EMR is a web service that makes it easier to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehouse management.
', 'operations' => [ 'AddInstanceFleet' => 'Adds an instance fleet to a running cluster.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x.
Adds one or more instance groups to a running cluster.
', 'AddJobFlowSteps' => 'AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.
If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop.
A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.
Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.
You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.
The string values passed into HadoopJarStep
object cannot exceed a total of 10240 characters.
Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
', 'CancelSteps' => 'Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a PENDING
or RUNNING
state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING
state.
Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
', 'CreateStudio' => 'Creates a new Amazon EMR Studio.
', 'CreateStudioSessionMapping' => 'Maps a user or group to the Amazon EMR Studio specified by StudioId
, and applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping
to assign users to a Studio when you use IAM Identity Center authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.
Deletes a security configuration.
', 'DeleteStudio' => 'Removes an Amazon EMR Studio from the Studio metadata store.
', 'DeleteStudioSessionMapping' => 'Removes a user or group from an Amazon EMR Studio.
', 'DescribeCluster' => 'Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
', 'DescribeJobFlows' => 'This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.
DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.
Regardless of supplied parameters, only job flows created within the last two months are returned.
If no parameters are supplied, then job flows matching either of the following criteria are returned:
Job flows created and completed in the last two weeks
Job flows created within the last two months that are in one of the following states: RUNNING
, WAITING
, SHUTTING_DOWN
, STARTING
Amazon EMR can return a maximum of 512 job flow descriptions.
', 'DescribeNotebookExecution' => 'Provides details of a notebook execution.
', 'DescribeReleaseLabel' => 'Provides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a specified version of Spark.
', 'DescribeSecurityConfiguration' => 'Provides the details of a security configuration by returning the configuration JSON.
', 'DescribeStep' => 'Provides more detail about the cluster step.
', 'DescribeStudio' => 'Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
', 'GetAutoTerminationPolicy' => 'Returns the auto-termination policy for an Amazon EMR cluster.
', 'GetBlockPublicAccessConfiguration' => 'Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
', 'GetClusterSessionCredentials' => 'Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.
', 'GetManagedScalingPolicy' => 'Fetches the attached managed scaling policy for an Amazon EMR cluster.
', 'GetStudioSessionMapping' => 'Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
', 'ListBootstrapActions' => 'Provides information about the bootstrap actions associated with a cluster.
', 'ListClusters' => 'Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.
', 'ListInstanceFleets' => 'Lists all available details about the instance fleets in a cluster.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides all available details about the instance groups in a cluster.
', 'ListInstances' => 'Provides information for all active Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
', 'ListNotebookExecutions' => 'Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecutions
calls.
Retrieves release labels of Amazon EMR services in the Region where the API is called.
', 'ListSecurityConfigurations' => 'Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.
', 'ListSteps' => 'Provides a list of steps for the cluster in reverse order unless you specify stepIds
with the request or filter by StepStates
. You can specify a maximum of 10 stepIDs
. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker
, which is a pagination token that indicates the next set of steps to retrieve.
Returns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId
.
Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.
', 'ListSupportedInstanceTypes' => 'A list of the instance types that Amazon EMR supports. You can filter the list by Amazon Web Services Region and Amazon EMR release.
', 'ModifyCluster' => 'Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
', 'ModifyInstanceFleet' => 'Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.
', 'PutAutoScalingPolicy' => 'Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric.
', 'PutAutoTerminationPolicy' => 'Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.
Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
', 'PutBlockPublicAccessConfiguration' => 'Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
', 'PutManagedScalingPolicy' => 'Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as Amazon EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'RemoveAutoScalingPolicy' => 'Removes an automatic scaling policy from a specified instance group within an Amazon EMR cluster.
', 'RemoveAutoTerminationPolicy' => 'Removes an auto-termination policy from an Amazon EMR cluster.
', 'RemoveManagedScalingPolicy' => 'Removes a managed scaling policy from a specified Amazon EMR cluster.
', 'RemoveTags' => 'Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
The following example removes the stack tag with value Prod from a cluster:
', 'RunJobFlow' => 'RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps
parameter is set to TRUE
, the cluster transitions to the WAITING state rather than shutting down after the steps have completed.
For additional protection, you can set the JobFlowInstancesConfig TerminationProtected
parameter to TRUE
to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error.
A maximum of 256 steps are allowed in each job flow.
If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop.
For long-running clusters, we recommend that you periodically store your results.
The instance fleets configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.
You can use the SetKeepJobFlowAliveWhenNoSteps
to configure a cluster (job flow) to terminate after the step execution, i.e., all your steps are executed. If you want a transient cluster that shuts down after the last of the current executing steps are completed, you can configure SetKeepJobFlowAliveWhenNoSteps
to false. If you want a long running cluster, configure SetKeepJobFlowAliveWhenNoSteps
to true.
For more information, see Managing Cluster Termination in the Amazon EMR Management Guide.
', 'SetTerminationProtection' => 'SetTerminationProtection locks a cluster (job flow) so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection
on a cluster is similar to calling the Amazon EC2 DisableAPITermination
API on all Amazon EC2 instances in a cluster.
SetTerminationProtection
is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage.
To terminate a cluster that has been locked by setting SetTerminationProtection
to true
, you must first unlock the job flow by a subsequent call to SetTerminationProtection
in which you set the value to false
.
For more information, see Managing Cluster Termination in the Amazon EMR Management Guide.
', 'SetUnhealthyNodeReplacement' => 'Specify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully replace core nodes on a cluster if any nodes become unhealthy. For example, a node becomes unhealthy if disk usage is above 90%. If unhealthy node replacement is on and TerminationProtected
are off, Amazon EMR immediately terminates the unhealthy core nodes. To use unhealthy node replacement and retain unhealthy core nodes, use to turn on termination protection. In such cases, Amazon EMR adds the unhealthy nodes to a denylist, reducing job interruptions and failures.
If unhealthy node replacement is on, Amazon EMR notifies YARN and other applications on the cluster to stop scheduling tasks with these nodes, moves the data, and then terminates the nodes.
For more information, see graceful node replacement in the Amazon EMR Management Guide.
', 'SetVisibleToAllUsers' => 'The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access Management for Amazon EMR.
Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.
This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.
For more information, see Understanding the Amazon EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.
', 'StartNotebookExecution' => 'Starts a notebook execution.
', 'StopNotebookExecution' => 'Stops a notebook execution.
', 'TerminateJobFlows' => 'TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the Amazon EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.
The maximum number of clusters allowed is 10. The call to TerminateJobFlows
is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.
Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
', 'UpdateStudioSessionMapping' => 'Updates the session policy attached to the user or group for the specified Amazon EMR Studio.
', ], 'shapes' => [ 'ActionOnFailure' => [ 'base' => NULL, 'refs' => [ 'Step$ActionOnFailure' => 'The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER
, CANCEL_AND_WAIT
, and CONTINUE
. TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend using TERMINATE_CLUSTER
instead.
If a cluster\'s StepConcurrencyLevel
is greater than 1
, do not use AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the ActionOnFailure
setting is not valid.
If you change a cluster\'s StepConcurrencyLevel
to be greater than 1 while a step is running, the ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
The action to take when the step fails. Use one of the following values:
TERMINATE_CLUSTER
- Shuts down the cluster.
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to the WAITING
state.
CONTINUE
- Continues to the next step in the queue.
TERMINATE_JOB_FLOW
- Shuts down the cluster. TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend using TERMINATE_CLUSTER
instead.
If a cluster\'s StepConcurrencyLevel
is greater than 1
, do not use AddJobFlowSteps
to submit a step with this parameter set to CANCEL_AND_WAIT
or TERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that the ActionOnFailure
setting is not valid.
If you change a cluster\'s StepConcurrencyLevel
to be greater than 1 while a step is running, the ActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER
, the cluster does not terminate.
The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility.
', ], ], 'AddInstanceFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'AddInstanceFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'AddInstanceGroupsInput' => [ 'base' => 'Input to an AddInstanceGroups call.
', 'refs' => [], ], 'AddInstanceGroupsOutput' => [ 'base' => 'Output from an AddInstanceGroups call.
', 'refs' => [], ], 'AddJobFlowStepsInput' => [ 'base' => 'The input argument to the AddJobFlowSteps operation.
', 'refs' => [], ], 'AddJobFlowStepsOutput' => [ 'base' => 'The output for the AddJobFlowSteps operation.
', 'refs' => [], ], 'AddTagsInput' => [ 'base' => 'This input identifies an Amazon EMR resource and a list of tags to attach.
', 'refs' => [], ], 'AddTagsOutput' => [ 'base' => 'This output indicates the result of adding tags to a resource.
', 'refs' => [], ], 'AdjustmentType' => [ 'base' => NULL, 'refs' => [ 'SimpleScalingPolicyConfiguration$AdjustmentType' => 'The way in which Amazon EC2 instances are added (if ScalingAdjustment
is a positive number) or terminated (if ScalingAdjustment
is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY
is the default. CHANGE_IN_CAPACITY
indicates that the Amazon EC2 instance count increments or decrements by ScalingAdjustment
, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY
indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment
, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY
indicates the scaling activity results in an instance group with the number of Amazon EC2 instances specified by ScalingAdjustment
, which should be expressed as a positive integer.
With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see Configuring Applications.
With earlier Amazon EMR releases, the application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument.
', 'refs' => [ 'ApplicationList$member' => NULL, ], ], 'ApplicationList' => [ 'base' => NULL, 'refs' => [ 'Cluster$Applications' => 'The applications installed on this cluster.
', 'RunJobFlowInput$Applications' => 'Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMRRelease Guide.
', ], ], 'ArnType' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetOutput$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'AddInstanceGroupsOutput$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'AddJobFlowStepsInput$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
.
For example, arn:aws:IAM::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
The Amazon Resource Name that created or last modified the configuration.
', 'Cluster$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'ClusterSummary$ClusterArn' => 'The Amazon Resource Name of the cluster.
', 'CreateStudioInput$IdcInstanceArn' => 'The ARN of the IAM Identity Center instance to create the Studio application.
', 'GetClusterSessionCredentialsInput$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for interactive workload submission on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
.
The Amazon Resource Name (ARN) of the cluster.
', 'RunJobFlowOutput$ClusterArn' => 'The Amazon Resource Name (ARN) of the cluster.
', 'Studio$IdcInstanceArn' => 'The ARN of the IAM Identity Center instance the Studio application belongs to.
', ], ], 'AuthMode' => [ 'base' => NULL, 'refs' => [ 'CreateStudioInput$AuthMode' => 'Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
', 'Studio$AuthMode' => 'Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
', 'StudioSummary$AuthMode' => 'Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
', ], ], 'AutoScalingPolicy' => [ 'base' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'refs' => [ 'InstanceGroupConfig$AutoScalingPolicy' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'PutAutoScalingPolicyInput$AutoScalingPolicy' => 'Specifies the definition of the automatic scaling policy.
', ], ], 'AutoScalingPolicyDescription' => [ 'base' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'refs' => [ 'InstanceGroup$AutoScalingPolicy' => 'An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
', 'PutAutoScalingPolicyOutput$AutoScalingPolicy' => 'The automatic scaling policy definition.
', ], ], 'AutoScalingPolicyState' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicyStatus$State' => 'Indicates the status of the automatic scaling policy.
', ], ], 'AutoScalingPolicyStateChangeReason' => [ 'base' => 'The reason for an AutoScalingPolicyStatus change.
', 'refs' => [ 'AutoScalingPolicyStatus$StateChangeReason' => 'The reason for a change in status.
', ], ], 'AutoScalingPolicyStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicyStateChangeReason$Code' => 'The code indicating the reason for the change in status.USER_REQUEST
indicates that the scaling policy status was changed by a user. PROVISION_FAILURE
indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE
indicates an error.
The status of an automatic scaling policy.
', 'refs' => [ 'AutoScalingPolicyDescription$Status' => 'The status of an automatic scaling policy.
', ], ], 'AutoTerminationPolicy' => [ 'base' => 'An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.
', 'refs' => [ 'GetAutoTerminationPolicyOutput$AutoTerminationPolicy' => 'Specifies the auto-termination policy that is attached to an Amazon EMR cluster.
', 'PutAutoTerminationPolicyInput$AutoTerminationPolicy' => 'Specifies the auto-termination policy to attach to the cluster.
', 'RunJobFlowInput$AutoTerminationPolicy' => NULL, ], ], 'BlockPublicAccessConfiguration' => [ 'base' => 'A configuration for Amazon EMR block public access. When BlockPublicSecurityGroupRules
is set to true
, Amazon EMR prevents cluster creation if one of the cluster\'s security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges
.
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges
in the BlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an Amazon EMR cluster in a Region before this date, block public access is enabled by default in that Region.
A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges
in the BlockPublicAccessConfiguration
. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules
to remove the exception.
For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an Amazon EMR cluster in a Region before this date, block public access is enabled by default in that Region.
Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration
using the PutBlockPublicAccessConfiguration
action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration
using the PutBlockPublicAccessConfiguration
action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
Indicates whether Amazon EMR block public access is enabled (true
) or disabled (false
). By default, the value is false
for accounts that have created Amazon EMR clusters before July 2019. For accounts created after this, the default is true
.
Specifies whether the cluster should terminate after completing all steps.
', 'Cluster$TerminationProtected' => 'Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
', 'Cluster$VisibleToAllUsers' => 'Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true
, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true
if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Specifies whether the cluster should remain available after completing all steps. Defaults to false
. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.
Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.
', 'JobFlowInstancesDetail$KeepJobFlowAliveWhenNoSteps' => 'Specifies whether the cluster should remain available after completing all steps.
', 'JobFlowInstancesDetail$TerminationProtected' => 'Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.
', 'RunJobFlowInput$VisibleToAllUsers' => 'The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true
. Setting it to false
now has no effect.
Set this value to true
so that IAM principals in the Amazon Web Services account associated with the cluster can perform Amazon EMR actions on the cluster that their IAM policies allow. This value defaults to true
for clusters created using the Amazon EMR API or the CLI create-cluster command.
When set to false
, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the Amazon EMR Management Guide.
A Boolean that indicates whether to terminate the cluster after all steps are executed.
', 'SetTerminationProtectionInput$TerminationProtected' => 'A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
', 'SetVisibleToAllUsersInput$VisibleToAllUsers' => 'A value of true
indicates that an IAM principal in the Amazon Web Services account can perform Amazon EMR actions on the cluster that the IAM policies attached to the principal allow. A value of false
indicates that only the IAM principal that created the cluster and the Amazon Web Services root user can perform Amazon EMR actions on the cluster.
Indicates whether the SupportedInstanceType
only supports 64-bit architecture.
Indicates whether the SupportedInstanceType
supports Amazon EBS optimization.
Indicates whether the SupportedInstanceType
uses Amazon EBS optimization by default.
Indicates whether the SupportedInstanceType
only supports Amazon EBS.
Indicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.
', 'CreateStudioInput$TrustedIdentityPropagationEnabled' => ' A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false
.
Indicates whether an Amazon EBS volume is EBS-optimized.
', 'InstanceGroup$EbsOptimized' => 'If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
', 'InstanceTypeSpecification$EbsOptimized' => 'Evaluates to TRUE
when the specified InstanceType
is EBS-optimized.
Indicates whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster.
', 'JobFlowInstancesDetail$UnhealthyNodeReplacement' => 'Indicates whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster.
', 'SetUnhealthyNodeReplacementInput$UnhealthyNodeReplacement' => 'Indicates whether to turn on or turn off graceful unhealthy node replacement.
', 'Studio$TrustedIdentityPropagationEnabled' => ' Indicates whether the Studio has Trusted identity propagation enabled. The default value is false
.
Configuration of a bootstrap action.
', 'refs' => [ 'BootstrapActionConfigList$member' => NULL, 'BootstrapActionDetail$BootstrapActionConfig' => 'A description of the bootstrap action.
', ], ], 'BootstrapActionConfigList' => [ 'base' => NULL, 'refs' => [ 'RunJobFlowInput$BootstrapActions' => 'A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
', ], ], 'BootstrapActionDetail' => [ 'base' => 'Reports the configuration of a bootstrap action in a cluster (job flow).
', 'refs' => [ 'BootstrapActionDetailList$member' => NULL, ], ], 'BootstrapActionDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$BootstrapActions' => 'A list of the bootstrap actions run by the job flow.
', ], ], 'CancelStepsInfo' => [ 'base' => 'Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.
', 'refs' => [ 'CancelStepsInfoList$member' => NULL, ], ], 'CancelStepsInfoList' => [ 'base' => NULL, 'refs' => [ 'CancelStepsOutput$CancelStepsInfoList' => 'A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID
specified.
The input argument to the CancelSteps operation.
', 'refs' => [], ], 'CancelStepsOutput' => [ 'base' => 'The output for the CancelSteps operation.
', 'refs' => [], ], 'CancelStepsRequestStatus' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInfo$Status' => 'The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.
', ], ], 'CloudWatchAlarmDefinition' => [ 'base' => 'The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.
', 'refs' => [ 'ScalingTrigger$CloudWatchAlarmDefinition' => 'The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
', ], ], 'Cluster' => [ 'base' => 'The detailed description of the cluster.
', 'refs' => [ 'DescribeClusterOutput$Cluster' => 'This output contains the details for the requested cluster.
', ], ], 'ClusterId' => [ 'base' => NULL, 'refs' => [ 'Cluster$Id' => 'The unique identifier for the cluster.
', 'ClusterSummary$Id' => 'The unique identifier for the cluster.
', 'DescribeClusterInput$ClusterId' => 'The identifier of the cluster to describe.
', 'DescribeStepInput$ClusterId' => 'The identifier of the cluster with steps to describe.
', 'GetAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster for which the auto-termination policy will be fetched.
', 'GetManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of the cluster for which the managed scaling policy will be fetched.
', 'ListBootstrapActionsInput$ClusterId' => 'The cluster identifier for the bootstrap actions to list.
', 'ListInstanceFleetsInput$ClusterId' => 'The unique identifier of the cluster.
', 'ListInstanceGroupsInput$ClusterId' => 'The identifier of the cluster for which to list the instance groups.
', 'ListInstancesInput$ClusterId' => 'The identifier of the cluster for which to list the instances.
', 'ListStepsInput$ClusterId' => 'The identifier of the cluster for which to list the steps.
', 'ModifyInstanceFleetInput$ClusterId' => 'The unique identifier of the cluster.
', 'ModifyInstanceGroupsInput$ClusterId' => 'The ID of the cluster to which the instance group belongs.
', 'PutAutoScalingPolicyInput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'PutAutoScalingPolicyOutput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'PutAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster to which the auto-termination policy will be attached.
', 'PutManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of an Amazon EMR cluster where the managed scaling policy is attached.
', 'RemoveAutoScalingPolicyInput$ClusterId' => 'Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
', 'RemoveAutoTerminationPolicyInput$ClusterId' => 'Specifies the ID of the Amazon EMR cluster from which the auto-termination policy will be removed.
', 'RemoveManagedScalingPolicyInput$ClusterId' => 'Specifies the ID of the cluster from which the managed scaling policy will be removed.
', ], ], 'ClusterState' => [ 'base' => NULL, 'refs' => [ 'ClusterStateList$member' => NULL, 'ClusterStatus$State' => 'The current state of the cluster.
', ], ], 'ClusterStateChangeReason' => [ 'base' => 'The reason that the cluster changed to its current state.
', 'refs' => [ 'ClusterStatus$StateChangeReason' => 'The reason for the cluster status change.
', ], ], 'ClusterStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'ClusterStateChangeReason$Code' => 'The programmatic code for the state change reason.
', ], ], 'ClusterStateList' => [ 'base' => NULL, 'refs' => [ 'ListClustersInput$ClusterStates' => 'The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.
', ], ], 'ClusterStatus' => [ 'base' => 'The detailed status of the cluster.
', 'refs' => [ 'Cluster$Status' => 'The current status details about the cluster.
', 'ClusterSummary$Status' => 'The details about the current status of the cluster.
', ], ], 'ClusterSummary' => [ 'base' => 'The summary description of the cluster.
', 'refs' => [ 'ClusterSummaryList$member' => NULL, ], ], 'ClusterSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListClustersOutput$Clusters' => 'The list of clusters for the account based on the given filters.
', ], ], 'ClusterTimeline' => [ 'base' => 'Represents the timeline of the cluster\'s lifecycle.
', 'refs' => [ 'ClusterStatus$Timeline' => 'A timeline that represents the status of a cluster over the lifetime of the cluster.
', ], ], 'Command' => [ 'base' => 'An entity describing an executable that runs on a cluster.
', 'refs' => [ 'CommandList$member' => NULL, ], ], 'CommandList' => [ 'base' => NULL, 'refs' => [ 'ListBootstrapActionsOutput$BootstrapActions' => 'The bootstrap actions associated with the cluster.
', ], ], 'ComparisonOperator' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$ComparisonOperator' => 'Determines how the metric specified by MetricName
is compared to the value specified by Threshold
.
The Amazon EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not be above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'refs' => [ 'ManagedScalingPolicy$ComputeLimits' => 'The Amazon EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is not allowed to go above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', ], ], 'ComputeLimitsUnitType' => [ 'base' => NULL, 'refs' => [ 'ComputeLimits$UnitType' => 'The unit type used for specifying a managed scaling policy.
', ], ], 'Configuration' => [ 'base' => 'Amazon EMR releases 4.x or later.
An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications.
', 'refs' => [ 'ConfigurationList$member' => NULL, ], ], 'ConfigurationList' => [ 'base' => NULL, 'refs' => [ 'Cluster$Configurations' => 'Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.
', 'Configuration$Configurations' => 'A list of additional configurations to apply within a configuration object.
', 'InstanceGroup$Configurations' => 'Amazon EMR releases 4.x or later.
The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
', 'InstanceGroup$LastSuccessfullyAppliedConfigurations' => 'A list of configurations that were successfully applied for an instance group last time.
', 'InstanceGroupConfig$Configurations' => 'Amazon EMR releases 4.x or later.
The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
', 'InstanceGroupModifyConfig$Configurations' => 'A list of new or modified configurations to apply for an instance group.
', 'InstanceTypeConfig$Configurations' => 'A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
', 'InstanceTypeSpecification$Configurations' => 'A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
', 'RunJobFlowInput$Configurations' => 'For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
', ], ], 'CreateSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStudioSessionMappingInput' => [ 'base' => NULL, 'refs' => [], ], 'Credentials' => [ 'base' => 'The credentials that you can use to connect to cluster endpoints. Credentials consist of a username and a password.
', 'refs' => [ 'GetClusterSessionCredentialsOutput$Credentials' => 'The credentials that you can use to connect to cluster endpoints that support username and password authentication.
', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'BlockPublicAccessConfigurationMetadata$CreationDateTime' => 'The date and time that the configuration was created.
', 'ClusterTimeline$CreationDateTime' => 'The creation date and time of the cluster.
', 'ClusterTimeline$ReadyDateTime' => 'The date and time when the cluster was ready to run steps.
', 'ClusterTimeline$EndDateTime' => 'The date and time when the cluster was terminated.
', 'CreateSecurityConfigurationOutput$CreationDateTime' => 'The date and time the security configuration was created.
', 'DescribeJobFlowsInput$CreatedAfter' => 'Return only job flows created after this date and time.
', 'DescribeJobFlowsInput$CreatedBefore' => 'Return only job flows created before this date and time.
', 'DescribeSecurityConfigurationOutput$CreationDateTime' => 'The date and time the security configuration was created
', 'GetClusterSessionCredentialsOutput$ExpiresAt' => 'The time when the credentials that are returned by the GetClusterSessionCredentials
API expire.
The time and date the instance fleet was created.
', 'InstanceFleetTimeline$ReadyDateTime' => 'The time and date the instance fleet was ready to run jobs.
', 'InstanceFleetTimeline$EndDateTime' => 'The time and date the instance fleet terminated.
', 'InstanceGroupDetail$CreationDateTime' => 'The date/time the instance group was created.
', 'InstanceGroupDetail$StartDateTime' => 'The date/time the instance group was started.
', 'InstanceGroupDetail$ReadyDateTime' => 'The date/time the instance group was available to the cluster.
', 'InstanceGroupDetail$EndDateTime' => 'The date/time the instance group was terminated.
', 'InstanceGroupTimeline$CreationDateTime' => 'The creation date and time of the instance group.
', 'InstanceGroupTimeline$ReadyDateTime' => 'The date and time when the instance group became ready to perform tasks.
', 'InstanceGroupTimeline$EndDateTime' => 'The date and time when the instance group terminated.
', 'InstanceTimeline$CreationDateTime' => 'The creation date and time of the instance.
', 'InstanceTimeline$ReadyDateTime' => 'The date and time when the instance was ready to perform tasks.
', 'InstanceTimeline$EndDateTime' => 'The date and time when the instance was terminated.
', 'JobFlowExecutionStatusDetail$CreationDateTime' => 'The creation date and time of the job flow.
', 'JobFlowExecutionStatusDetail$StartDateTime' => 'The start date and time of the job flow.
', 'JobFlowExecutionStatusDetail$ReadyDateTime' => 'The date and time when the job flow was ready to start running bootstrap actions.
', 'JobFlowExecutionStatusDetail$EndDateTime' => 'The completion date and time of the job flow.
', 'ListClustersInput$CreatedAfter' => 'The creation date and time beginning value filter for listing clusters.
', 'ListClustersInput$CreatedBefore' => 'The creation date and time end value filter for listing clusters.
', 'ListNotebookExecutionsInput$From' => 'The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
', 'ListNotebookExecutionsInput$To' => 'The end of time range filter for listing notebook executions. The default is the current timestamp.
', 'NotebookExecution$StartTime' => 'The timestamp when notebook execution started.
', 'NotebookExecution$EndTime' => 'The timestamp when notebook execution ended.
', 'NotebookExecutionSummary$StartTime' => 'The timestamp when notebook execution started.
', 'NotebookExecutionSummary$EndTime' => 'The timestamp when notebook execution started.
', 'SecurityConfigurationSummary$CreationDateTime' => 'The date and time the security configuration was created.
', 'SessionMappingDetail$CreationTime' => 'The time the session mapping was created.
', 'SessionMappingDetail$LastModifiedTime' => 'The time the session mapping was last modified.
', 'SessionMappingSummary$CreationTime' => 'The time the session mapping was created.
', 'StepExecutionStatusDetail$CreationDateTime' => 'The creation date and time of the step.
', 'StepExecutionStatusDetail$StartDateTime' => 'The start date and time of the step.
', 'StepExecutionStatusDetail$EndDateTime' => 'The completion date and time of the step.
', 'StepTimeline$CreationDateTime' => 'The date and time when the cluster step was created.
', 'StepTimeline$StartDateTime' => 'The date and time when the cluster step execution started.
', 'StepTimeline$EndDateTime' => 'The date and time when the cluster step execution completed or failed.
', 'Studio$CreationTime' => 'The time the Amazon EMR Studio was created.
', 'StudioSummary$CreationTime' => 'The time when the Amazon EMR Studio was created.
', ], ], 'DeleteSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStudioSessionMappingInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClusterInput' => [ 'base' => 'This input determines which cluster to describe.
', 'refs' => [], ], 'DescribeClusterOutput' => [ 'base' => 'This output contains the description of the cluster.
', 'refs' => [], ], 'DescribeJobFlowsInput' => [ 'base' => 'The input for the DescribeJobFlows operation.
', 'refs' => [], ], 'DescribeJobFlowsOutput' => [ 'base' => 'The output for the DescribeJobFlows operation.
', 'refs' => [], ], 'DescribeNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeNotebookExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeReleaseLabelInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeReleaseLabelOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSecurityConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStepInput' => [ 'base' => 'This input determines which step to describe.
', 'refs' => [], ], 'DescribeStepOutput' => [ 'base' => 'This output contains the description of the cluster step.
', 'refs' => [], ], 'DescribeStudioInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStudioOutput' => [ 'base' => NULL, 'refs' => [], ], 'EC2InstanceIdsList' => [ 'base' => NULL, 'refs' => [ 'InstanceResizePolicy$InstancesToTerminate' => 'Specific list of instances to be terminated when shrinking an instance group.
', 'InstanceResizePolicy$InstancesToProtect' => 'Specific list of instances to be protected when shrinking an instance group.
', ], ], 'EC2InstanceIdsToTerminateList' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupModifyConfig$EC2InstanceIdsToTerminate' => 'The Amazon EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
', ], ], 'EbsBlockDevice' => [ 'base' => 'Configuration of requested EBS block device associated with the instance group.
', 'refs' => [ 'EbsBlockDeviceList$member' => NULL, ], ], 'EbsBlockDeviceConfig' => [ 'base' => 'Configuration of requested EBS block device associated with the instance group with count of volumes that are associated to every instance.
', 'refs' => [ 'EbsBlockDeviceConfigList$member' => NULL, ], ], 'EbsBlockDeviceConfigList' => [ 'base' => NULL, 'refs' => [ 'EbsConfiguration$EbsBlockDeviceConfigs' => 'An array of Amazon EBS volume specifications attached to a cluster instance.
', ], ], 'EbsBlockDeviceList' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$EbsBlockDevices' => 'The EBS block devices that are mapped to this instance group.
', 'InstanceTypeSpecification$EbsBlockDevices' => 'The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType
.
The Amazon EBS configuration of a cluster instance.
', 'refs' => [ 'InstanceGroupConfig$EbsConfiguration' => 'EBS configurations that will be attached to each Amazon EC2 instance in the instance group.
', 'InstanceTypeConfig$EbsConfiguration' => 'The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType
.
EBS block device that\'s attached to an Amazon EC2 instance.
', 'refs' => [ 'EbsVolumeList$member' => NULL, ], ], 'EbsVolumeList' => [ 'base' => NULL, 'refs' => [ 'Instance$EbsVolumes' => 'The list of Amazon EBS volumes that are attached to this instance.
', ], ], 'Ec2InstanceAttributes' => [ 'base' => 'Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
', 'refs' => [ 'Cluster$Ec2InstanceAttributes' => 'Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
', ], ], 'EnvironmentVariablesMap' => [ 'base' => NULL, 'refs' => [ 'NotebookExecution$EnvironmentVariables' => 'The environment variables associated with the notebook execution.
', 'StartNotebookExecutionInput$EnvironmentVariables' => 'The environment variables associated with the notebook execution.
', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'InvalidRequestException$ErrorCode' => 'The error code associated with the exception.
', ], ], 'ErrorData' => [ 'base' => NULL, 'refs' => [ 'ErrorDetail$ErrorData' => 'A list of key value pairs that provides contextual information about why an error occured.
', ], ], 'ErrorDetail' => [ 'base' => 'A tuple that provides information about an error that caused a cluster to terminate.
', 'refs' => [ 'ErrorDetailList$member' => NULL, ], ], 'ErrorDetailList' => [ 'base' => NULL, 'refs' => [ 'ClusterStatus$ErrorDetails' => 'A list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different ErrorDetail
tuples.
The message associated with the exception.
', 'InvalidRequestException$Message' => 'The message associated with the exception.
', ], ], 'ExecutionEngineConfig' => [ 'base' => 'Specifies the execution engine (cluster) to run the notebook and perform the notebook execution, for example, an Amazon EMR cluster.
', 'refs' => [ 'NotebookExecution$ExecutionEngine' => 'The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
', 'StartNotebookExecutionInput$ExecutionEngine' => 'Specifies the execution engine (cluster) that runs the notebook execution.
', ], ], 'ExecutionEngineType' => [ 'base' => NULL, 'refs' => [ 'ExecutionEngineConfig$Type' => 'The type of execution engine. A value of EMR
specifies an Amazon EMR cluster.
The details of the step failure. The service attempts to detect the root cause for many common failures.
', 'refs' => [ 'StepStatus$FailureDetails' => 'The details for the step failure including reason, message, and log file path where the root cause was identified.
', ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'SupportedInstanceType$MemoryGB' => 'The amount of memory that is available to Amazon EMR from the SupportedInstanceType
. The kernel and hypervisor software consume some memory, so this value might be lower than the overall memory for the instance type.
A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
', 'refs' => [ 'StepConfig$HadoopJarStep' => 'The JAR file used for the step.
', ], ], 'HadoopStepConfig' => [ 'base' => 'A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
', 'refs' => [ 'Step$Config' => 'The Hadoop job configuration of the cluster step.
', 'StepSummary$Config' => 'The Hadoop job configuration of the cluster step.
', ], ], 'IAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'ExecutionEngineConfig$ExecutionRoleArn' => 'The execution role ARN required for the notebook execution.
', ], ], 'IdcUserAssignment' => [ 'base' => NULL, 'refs' => [ 'CreateStudioInput$IdcUserAssignment' => ' Specifies whether IAM Identity Center user assignment is REQUIRED
or OPTIONAL
. If the value is set to REQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.
Indicates whether the Studio has REQUIRED
or OPTIONAL
IAM Identity Center user assignment. If the value is set to REQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.
Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.
', 'DeleteStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.
', 'GetStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to fetch is a user or a group.
', 'ListStudioSessionMappingsInput$IdentityType' => 'Specifies whether to return session mappings for users or groups. If not specified, the results include session mapping details for both users and groups.
', 'SessionMappingDetail$IdentityType' => 'Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
', 'SessionMappingSummary$IdentityType' => 'Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.
', 'UpdateStudioSessionMappingInput$IdentityType' => 'Specifies whether the identity to update is a user or a group.
', ], ], 'Instance' => [ 'base' => 'Represents an Amazon EC2 instance provisioned as part of cluster.
', 'refs' => [ 'InstanceList$member' => NULL, ], ], 'InstanceCollectionType' => [ 'base' => NULL, 'refs' => [ 'Cluster$InstanceCollectionType' => 'The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The instance group configuration of the cluster. A value of INSTANCE_GROUP
indicates a uniform instance group configuration. A value of INSTANCE_FLEET
indicates an instance fleets configuration.
Describes an instance fleet, which is a group of Amazon EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The configuration that defines an instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Specifies the configuration of the instance fleet.
', 'InstanceFleetConfigList$member' => NULL, ], ], 'InstanceFleetConfigList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesConfig$InstanceFleets' => 'The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Describes the Amazon EC2 instances and instance configurations for clusters that use the instance fleet configuration.
', ], ], 'InstanceFleetId' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetOutput$InstanceFleetId' => 'The unique identifier of the instance fleet.
', 'Instance$InstanceFleetId' => 'The unique identifier of the instance fleet to which an Amazon EC2 instance belongs.
', 'InstanceFleet$Id' => 'The unique identifier of the instance fleet.
', 'InstanceFleetModifyConfig$InstanceFleetId' => 'A unique identifier for the instance fleet.
', 'ListInstancesInput$InstanceFleetId' => 'The unique identifier of the instance fleet.
', ], ], 'InstanceFleetList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceFleetsOutput$InstanceFleets' => 'The list of instance fleets for the cluster and given filters.
', ], ], 'InstanceFleetModifyConfig' => [ 'base' => 'Configuration parameters for an instance fleet modification request.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The configuration parameters of the instance fleet.
', ], ], 'InstanceFleetProvisioningSpecifications' => [ 'base' => 'The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation strategies are available in Amazon EMR releases 5.12.1 and later.
Describes the launch specification for an instance fleet.
', 'InstanceFleetConfig$LaunchSpecifications' => 'The launch specification for the instance fleet.
', ], ], 'InstanceFleetResizingSpecifications' => [ 'base' => 'The resize specification for On-Demand and Spot Instances in the fleet.
', 'refs' => [ 'InstanceFleet$ResizeSpecifications' => 'The resize specification for the instance fleet.
', 'InstanceFleetConfig$ResizeSpecifications' => 'The resize specification for the instance fleet.
', 'InstanceFleetModifyConfig$ResizeSpecifications' => 'The resize specification for the instance fleet.
', ], ], 'InstanceFleetState' => [ 'base' => NULL, 'refs' => [ 'InstanceFleetStatus$State' => 'A code representing the instance fleet status.
PROVISIONING
—The instance fleet is provisioning Amazon EC2 resources and is not yet ready to run jobs.
BOOTSTRAPPING
—Amazon EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway.
RUNNING
—Amazon EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs.
RESIZING
—A resize operation is underway. Amazon EC2 instances are either being added or removed.
SUSPENDED
—A resize operation could not complete. Existing Amazon EC2 instances are running, but instances can\'t be added or removed.
TERMINATING
—The instance fleet is terminating Amazon EC2 instances.
TERMINATED
—The instance fleet is no longer active, and all Amazon EC2 instances have been terminated.
Provides status change reason details for the instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides status change reason details for the instance fleet.
', ], ], 'InstanceFleetStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceFleetStateChangeReason$Code' => 'A code corresponding to the reason the state change occurred.
', ], ], 'InstanceFleetStatus' => [ 'base' => 'The status of the instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The current status of the instance fleet.
', ], ], 'InstanceFleetTimeline' => [ 'base' => 'Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
', ], ], 'InstanceFleetType' => [ 'base' => NULL, 'refs' => [ 'InstanceFleet$InstanceFleetType' => 'The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
', 'InstanceFleetConfig$InstanceFleetType' => 'The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.
', 'ListInstancesInput$InstanceFleetType' => 'The node type of the instance fleet. For example MASTER, CORE, or TASK.
', ], ], 'InstanceGroup' => [ 'base' => 'This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.
', 'refs' => [ 'InstanceGroupList$member' => NULL, ], ], 'InstanceGroupConfig' => [ 'base' => 'Configuration defining a new instance group.
', 'refs' => [ 'InstanceGroupConfigList$member' => NULL, ], ], 'InstanceGroupConfigList' => [ 'base' => NULL, 'refs' => [ 'AddInstanceGroupsInput$InstanceGroups' => 'Instance groups to add.
', 'JobFlowInstancesConfig$InstanceGroups' => 'Configuration for the instance groups in a cluster.
', ], ], 'InstanceGroupDetail' => [ 'base' => 'Detailed information about an instance group.
', 'refs' => [ 'InstanceGroupDetailList$member' => NULL, ], ], 'InstanceGroupDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesDetail$InstanceGroups' => 'Details about the instance groups in a cluster.
', ], ], 'InstanceGroupId' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$Id' => 'The identifier of the instance group.
', 'ListInstancesInput$InstanceGroupId' => 'The identifier of the instance group for which to list the instances.
', 'PutAutoScalingPolicyInput$InstanceGroupId' => 'Specifies the ID of the instance group to which the automatic scaling policy is applied.
', 'PutAutoScalingPolicyOutput$InstanceGroupId' => 'Specifies the ID of the instance group to which the scaling policy is applied.
', 'RemoveAutoScalingPolicyInput$InstanceGroupId' => 'Specifies the ID of the instance group to which the scaling policy is applied.
', ], ], 'InstanceGroupIdsList' => [ 'base' => NULL, 'refs' => [ 'AddInstanceGroupsOutput$InstanceGroupIds' => 'Instance group IDs of the newly created instance groups.
', ], ], 'InstanceGroupList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceGroupsOutput$InstanceGroups' => 'The list of instance groups for the cluster and given filters.
', ], ], 'InstanceGroupModifyConfig' => [ 'base' => 'Modify the size or configurations of an instance group.
', 'refs' => [ 'InstanceGroupModifyConfigList$member' => NULL, ], ], 'InstanceGroupModifyConfigList' => [ 'base' => NULL, 'refs' => [ 'ModifyInstanceGroupsInput$InstanceGroups' => 'Instance groups to change.
', ], ], 'InstanceGroupState' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupDetail$State' => 'State of instance group. The following values are no longer supported: STARTING, TERMINATED, and FAILED.
', 'InstanceGroupStatus$State' => 'The current state of the instance group.
', ], ], 'InstanceGroupStateChangeReason' => [ 'base' => 'The status change reason details for the instance group.
', 'refs' => [ 'InstanceGroupStatus$StateChangeReason' => 'The status change reason details for the instance group.
', ], ], 'InstanceGroupStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupStateChangeReason$Code' => 'The programmable code for the state change reason.
', ], ], 'InstanceGroupStatus' => [ 'base' => 'The details of the instance group status.
', 'refs' => [ 'InstanceGroup$Status' => 'The current status of the instance group.
', ], ], 'InstanceGroupTimeline' => [ 'base' => 'The timeline of the instance group lifecycle.
', 'refs' => [ 'InstanceGroupStatus$Timeline' => 'The timeline of the instance group status over time.
', ], ], 'InstanceGroupType' => [ 'base' => NULL, 'refs' => [ 'InstanceGroup$InstanceGroupType' => 'The type of the instance group. Valid values are MASTER, CORE or TASK.
', 'InstanceGroupTypeList$member' => NULL, ], ], 'InstanceGroupTypeList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesInput$InstanceGroupTypes' => 'The type of instance group for which to list the instances.
', ], ], 'InstanceId' => [ 'base' => NULL, 'refs' => [ 'EC2InstanceIdsList$member' => NULL, 'EC2InstanceIdsToTerminateList$member' => NULL, 'Instance$Id' => 'The unique identifier for the instance in Amazon EMR.
', 'Instance$Ec2InstanceId' => 'The unique identifier of the instance in Amazon EC2.
', ], ], 'InstanceList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesOutput$Instances' => 'The list of instances for the cluster and given filters.
', ], ], 'InstanceResizePolicy' => [ 'base' => 'Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
', 'refs' => [ 'ShrinkPolicy$InstanceResizePolicy' => 'Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
', ], ], 'InstanceRoleType' => [ 'base' => NULL, 'refs' => [ 'InstanceGroupConfig$InstanceRole' => 'The role of the instance group in the cluster.
', 'InstanceGroupDetail$InstanceRole' => 'Instance group role in the cluster
', 'PlacementGroupConfig$InstanceRole' => 'Role of the instance in the cluster.
Starting with Amazon EMR release 5.23.0, the only supported instance role is MASTER
.
The current state of the instance.
', ], ], 'InstanceStateChangeReason' => [ 'base' => 'The details of the status change reason for the instance.
', 'refs' => [ 'InstanceStatus$StateChangeReason' => 'The details of the status change reason for the instance.
', ], ], 'InstanceStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'InstanceStateChangeReason$Code' => 'The programmable code for the state change reason.
', ], ], 'InstanceStateList' => [ 'base' => NULL, 'refs' => [ 'ListInstancesInput$InstanceStates' => 'A list of instance states that will filter the instances returned with this request.
', ], ], 'InstanceStatus' => [ 'base' => 'The instance status details.
', 'refs' => [ 'Instance$Status' => 'The current status of the instance.
', ], ], 'InstanceTimeline' => [ 'base' => 'The timeline of the instance lifecycle.
', 'refs' => [ 'InstanceStatus$Timeline' => 'The timeline of the instance status over time.
', ], ], 'InstanceType' => [ 'base' => NULL, 'refs' => [ 'Instance$InstanceType' => 'The Amazon EC2 instance type, for example m3.xlarge
.
The Amazon EC2 instance type for all instances in the instance group.
', 'InstanceGroupConfig$InstanceType' => 'The Amazon EC2 instance type for all instances in the instance group.
', 'InstanceGroupDetail$InstanceType' => 'Amazon EC2 instance type.
', 'InstanceTypeConfig$InstanceType' => 'An Amazon EC2 instance type, such as m3.xlarge
.
The Amazon EC2 instance type, for example m3.xlarge
.
The Amazon EC2 instance type of the master node.
', 'JobFlowInstancesConfig$SlaveInstanceType' => 'The Amazon EC2 instance type of the core and task nodes.
', 'JobFlowInstancesDetail$MasterInstanceType' => 'The Amazon EC2 master node instance type.
', 'JobFlowInstancesDetail$SlaveInstanceType' => 'The Amazon EC2 core and task node instance type.
', ], ], 'InstanceTypeConfig' => [ 'base' => 'An instance type configuration for each instance type in an instance fleet, which determines the Amazon EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can include a maximum of 30 instance type configurations for a fleet. For more information about how to use an allocation strategy, see Configure Instance Fleets. Without an allocation strategy, you may specify a maximum of five instance type configurations for a fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The instance type configurations that define the Amazon EC2 instances in the instance fleet.
', ], ], 'InstanceTypeSpecification' => [ 'base' => 'The configuration specification for each instance type in an instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
An array of specifications for the instance types that comprise an instance fleet.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$EvaluationPeriods' => 'The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1
.
The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300
.
An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
', 'Cluster$EbsRootVolumeSize' => 'The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.
', 'Cluster$StepConcurrencyLevel' => 'Specifies the number of steps that can be executed concurrently.
', 'Cluster$EbsRootVolumeIops' => 'The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
', 'Cluster$EbsRootVolumeThroughput' => 'The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
', 'ClusterSummary$NormalizedInstanceHours' => 'An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
', 'ComputeLimits$MinimumCapacityUnits' => 'The lower boundary of Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'ComputeLimits$MaximumCapacityUnits' => 'The upper boundary of Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'ComputeLimits$MaximumOnDemandCapacityUnits' => 'The upper boundary of On-Demand Amazon EC2 units. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. The On-Demand units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between On-Demand and Spot Instances.
', 'ComputeLimits$MaximumCoreCapacityUnits' => 'The upper boundary of Amazon EC2 units for core node type in a cluster. It is measured through vCPU cores or instances for instance groups and measured through units for instance fleets. The core units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between core and task nodes.
', 'EbsBlockDeviceConfig$VolumesPerInstance' => 'Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group
', 'InstanceGroup$RequestedInstanceCount' => 'The target number of instances for the instance group.
', 'InstanceGroup$RunningInstanceCount' => 'The number of instances currently running in this instance group.
', 'InstanceGroupConfig$InstanceCount' => 'Target number of instances for the instance group.
', 'InstanceGroupDetail$InstanceRequestCount' => 'Target number of instances to run in the instance group.
', 'InstanceGroupDetail$InstanceRunningCount' => 'Actual count of running instances.
', 'InstanceGroupModifyConfig$InstanceCount' => 'Target size for the instance group.
', 'InstanceResizePolicy$InstanceTerminationTimeout' => 'Decommissioning timeout override for the specific list of instances to be terminated.
', 'JobFlowInstancesConfig$InstanceCount' => 'The number of Amazon EC2 instances in the cluster.
', 'JobFlowInstancesDetail$InstanceCount' => 'The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.
', 'JobFlowInstancesDetail$NormalizedInstanceHours' => 'An approximation of the cost of the cluster, represented in m1.small/hours. This value is increased one time for every hour that an m1.small instance runs. Larger instances are weighted more heavily, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being increased incrementally four times. This result is only an approximation and does not reflect the actual billing rate.
', 'ModifyClusterInput$StepConcurrencyLevel' => 'The number of steps that can be executed concurrently. You can specify a minimum of 1 step and a maximum of 256 steps. We recommend that you do not change this parameter while steps are running or the ActionOnFailure
setting may not behave as expected. For more information see Step$ActionOnFailure.
The number of steps that can be executed concurrently.
', 'RunJobFlowInput$EbsRootVolumeSize' => 'The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.
', 'RunJobFlowInput$StepConcurrencyLevel' => 'Specifies the number of steps that can be executed concurrently. The default value is 1
. The maximum value is 256
.
The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
', 'RunJobFlowInput$EbsRootVolumeThroughput' => 'The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.
', 'ScalingConstraints$MinCapacity' => 'The lower boundary of Amazon EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.
', 'ScalingConstraints$MaxCapacity' => 'The upper boundary of Amazon EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.
', 'ShrinkPolicy$DecommissionTimeout' => 'The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
', 'SimpleScalingPolicyConfiguration$ScalingAdjustment' => 'The amount by which to scale in or scale out, based on the specified AdjustmentType
. A positive value adds to the instance group\'s Amazon EC2 instance count while a negative number removes instances. If AdjustmentType
is set to EXACT_CAPACITY
, the number should only be a positive integer. If AdjustmentType
is set to PERCENT_CHANGE_IN_CAPACITY
, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.
', 'SupportedInstanceType$StorageGB' => ' StorageGB
represents the storage capacity of the SupportedInstanceType
. This value is 0
for Amazon EBS-only instance types.
The number of vCPUs available for the SupportedInstanceType
.
Number of disks for the SupportedInstanceType
. This value is 0
for Amazon EBS-only instance types.
The number of I/O operations per second (IOPS) that the volume supports.
', 'VolumeSpecification$SizeInGB' => 'The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
', ], ], 'InternalServerError' => [ 'base' => 'Indicates that an error occurred while processing the request and that the request was not completed.
', 'refs' => [], ], 'InternalServerException' => [ 'base' => 'This exception occurs when there is an internal failure in the Amazon EMR service.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'This exception occurs when there is something wrong with user input.
', 'refs' => [], ], 'JobFlowDetail' => [ 'base' => 'A description of a cluster (job flow).
', 'refs' => [ 'JobFlowDetailList$member' => NULL, ], ], 'JobFlowDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsOutput$JobFlows' => 'A list of job flows matching the parameters supplied.
', ], ], 'JobFlowExecutionState' => [ 'base' => 'The type of instance.
', 'refs' => [ 'JobFlowExecutionStateList$member' => NULL, 'JobFlowExecutionStatusDetail$State' => 'The state of the job flow.
', ], ], 'JobFlowExecutionStateList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsInput$JobFlowStates' => 'Return only job flows whose state is contained in this list.
', ], ], 'JobFlowExecutionStatusDetail' => [ 'base' => 'Describes the status of the cluster (job flow).
', 'refs' => [ 'JobFlowDetail$ExecutionStatusDetail' => 'Describes the execution status of the job flow.
', ], ], 'JobFlowInstancesConfig' => [ 'base' => 'A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don\'t recommend this configuration.
', 'refs' => [ 'RunJobFlowInput$Instances' => 'A specification of the number and type of Amazon EC2 instances.
', ], ], 'JobFlowInstancesDetail' => [ 'base' => 'Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.
', 'refs' => [ 'JobFlowDetail$Instances' => 'Describes the Amazon EC2 instances of the job flow.
', ], ], 'KerberosAttributes' => [ 'base' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', 'refs' => [ 'Cluster$KerberosAttributes' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', 'RunJobFlowInput$KerberosAttributes' => 'Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.
', ], ], 'KeyValue' => [ 'base' => 'A key-value pair.
', 'refs' => [ 'KeyValueList$member' => NULL, ], ], 'KeyValueList' => [ 'base' => NULL, 'refs' => [ 'HadoopJarStepConfig$Properties' => 'A list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.
', ], ], 'ListBootstrapActionsInput' => [ 'base' => 'This input determines which bootstrap actions to retrieve.
', 'refs' => [], ], 'ListBootstrapActionsOutput' => [ 'base' => 'This output contains the bootstrap actions detail.
', 'refs' => [], ], 'ListClustersInput' => [ 'base' => 'This input determines how the ListClusters action filters the list of clusters that it returns.
', 'refs' => [], ], 'ListClustersOutput' => [ 'base' => 'This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.
', 'refs' => [], ], 'ListInstanceFleetsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceFleetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceGroupsInput' => [ 'base' => 'This input determines which instance groups to retrieve.
', 'refs' => [], ], 'ListInstanceGroupsOutput' => [ 'base' => 'This input determines which instance groups to retrieve.
', 'refs' => [], ], 'ListInstancesInput' => [ 'base' => 'This input determines which instances to list.
', 'refs' => [], ], 'ListInstancesOutput' => [ 'base' => 'This output contains the list of instances.
', 'refs' => [], ], 'ListNotebookExecutionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotebookExecutionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReleaseLabelsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReleaseLabelsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityConfigurationsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSecurityConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStepsInput' => [ 'base' => 'This input determines which steps to list.
', 'refs' => [], ], 'ListStepsOutput' => [ 'base' => 'This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.
', 'refs' => [], ], 'ListStudioSessionMappingsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudioSessionMappingsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudiosInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStudiosOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedInstanceTypesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSupportedInstanceTypesOutput' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AutoTerminationPolicy$IdleTimeout' => 'Specifies the amount of idle time in seconds after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).
', 'InstanceGroup$ConfigurationsVersion' => 'The version number of the requested configuration specification for this instance group.
', 'InstanceGroup$LastSuccessfullyAppliedConfigurationsVersion' => 'The version number of a configuration specification that was successfully applied for an instance group last time.
', ], ], 'ManagedScalingPolicy' => [ 'base' => 'Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.
', 'refs' => [ 'GetManagedScalingPolicyOutput$ManagedScalingPolicy' => 'Specifies the managed scaling policy that is attached to an Amazon EMR cluster.
', 'PutManagedScalingPolicyInput$ManagedScalingPolicy' => 'Specifies the constraints for the managed scaling policy.
', 'RunJobFlowInput$ManagedScalingPolicy' => 'The specified managed scaling policy for an Amazon EMR cluster.
', ], ], 'Marker' => [ 'base' => NULL, 'refs' => [ 'ListBootstrapActionsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListBootstrapActionsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListClustersInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListClustersOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceFleetsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceFleetsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceGroupsInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstanceGroupsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstancesInput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListInstancesOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListNotebookExecutionsInput$Marker' => 'The pagination token, returned by a previous ListNotebookExecutions
call, that indicates the start of the list for this ListNotebookExecutions
call.
A pagination token that a subsequent ListNotebookExecutions
can use to determine the next set of results to retrieve.
The pagination token that indicates the set of results to retrieve.
', 'ListSecurityConfigurationsOutput$Marker' => 'A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.
', 'ListStepsInput$Marker' => 'The maximum number of steps that a single ListSteps
action returns is 50. To return a longer list of steps, use multiple ListSteps
actions along with the Marker
parameter, which is a pagination token that indicates the next set of results to retrieve.
The maximum number of steps that a single ListSteps
action returns is 50. To return a longer list of steps, use multiple ListSteps
actions along with the Marker
parameter, which is a pagination token that indicates the next set of results to retrieve.
The pagination token that indicates the set of results to retrieve.
', 'ListStudioSessionMappingsOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', 'ListStudiosInput$Marker' => 'The pagination token that indicates the set of results to retrieve.
', 'ListStudiosOutput$Marker' => 'The pagination token that indicates the next set of results to retrieve.
', ], ], 'MarketType' => [ 'base' => NULL, 'refs' => [ 'Instance$Market' => 'The instance purchasing option. Valid values are ON_DEMAND
or SPOT
.
The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
', 'InstanceGroupConfig$Market' => 'Market type of the Amazon EC2 instances used to create a cluster node.
', 'InstanceGroupDetail$Market' => 'Market type of the Amazon EC2 instances used to create a cluster node.
', 'ScalingAction$Market' => 'Not available for instance groups. Instance groups use the market type specified for the group.
', ], ], 'MaxResultsNumber' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelInput$MaxResults' => 'Reserved for future use. Currently set to null.
', 'ListReleaseLabelsInput$MaxResults' => 'Defines the maximum number of release labels to return in a single response. The default is 100
.
A CloudWatch dimension, which is specified using a Key
(known as a Name
in CloudWatch), Value
pair. By default, Amazon EMR uses one dimension whose Key
is JobFlowID
and Value
is a variable representing the cluster ID, which is ${emr.clusterId}
. This enables the rule to bootstrap when the cluster ID becomes available.
A CloudWatch metric dimension.
', ], ], 'ModifyClusterInput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClusterOutput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyInstanceFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'ModifyInstanceGroupsInput' => [ 'base' => 'Change the size of some instance groups.
', 'refs' => [], ], 'NewSupportedProductsList' => [ 'base' => NULL, 'refs' => [ 'RunJobFlowInput$NewSupportedProducts' => 'For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.
A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. Supported values are:
"mapr-m3" - launch the cluster using MapR M3 Edition.
"mapr-m5" - launch the cluster using MapR M5 Edition.
"mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.
"mapr-m7" - launch the cluster using MapR M7 Edition.
"hunk" - launch the cluster with the Hunk Big Data Analytics Platform.
"hue"- launch the cluster with Hue installed.
"spark" - launch the cluster with Apache Spark installed.
"ganglia" - launch the cluster with the Ganglia Monitoring System installed.
The value against which the specified statistic is compared.
', 'InstanceTypeConfig$BidPriceAsPercentageOfOnDemandPrice' => 'The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType
. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is provided, BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
', 'InstanceTypeSpecification$BidPriceAsPercentageOfOnDemandPrice' => 'The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType
. Expressed as a number (for example, 20 specifies 20%).
The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
', ], ], 'NotebookExecution' => [ 'base' => 'A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution
action.
Properties of the notebook execution.
', ], ], 'NotebookExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ListNotebookExecutionsInput$Status' => 'The status filter for listing notebook executions.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
The status of the notebook execution.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
The status of the notebook execution.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.
STARTING
indicates that the execution is starting on the cluster.
RUNNING
indicates that the execution is being processed by the cluster.
FINISHING
indicates that execution processing is in the final stages.
FINISHED
indicates that the execution has completed without error.
FAILING
indicates that the execution is failing and will not finish successfully.
FAILED
indicates that the execution failed.
STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request and the stop is pending.
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution
request.
STOPPED
indicates that the execution stopped because of a StopNotebookExecution
request.
Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.
', 'refs' => [ 'NotebookExecutionSummaryList$member' => NULL, ], ], 'NotebookExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListNotebookExecutionsOutput$NotebookExecutions' => 'A list of notebook executions.
', ], ], 'NotebookS3LocationForOutput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution input.
', 'refs' => [ 'NotebookExecution$NotebookS3Location' => 'The Amazon S3 location that stores the notebook execution input.
', 'NotebookExecutionSummary$NotebookS3Location' => 'The Amazon S3 location that stores the notebook execution input.
', ], ], 'NotebookS3LocationFromInput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution input.
', 'refs' => [ 'StartNotebookExecutionInput$NotebookS3Location' => 'The Amazon S3 location for the notebook execution input.
', ], ], 'OSRelease' => [ 'base' => 'The Amazon Linux release specified for a cluster in the RunJobFlow request.
', 'refs' => [ 'OSReleaseList$member' => NULL, ], ], 'OSReleaseList' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelOutput$AvailableOSReleases' => 'The list of available Amazon Linux release versions for an Amazon EMR release. Contains a Label field that is formatted as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
', ], ], 'OnDemandCapacityReservationOptions' => [ 'base' => 'Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
', 'refs' => [ 'OnDemandProvisioningSpecification$CapacityReservationOptions' => 'The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.
', ], ], 'OnDemandCapacityReservationPreference' => [ 'base' => NULL, 'refs' => [ 'OnDemandCapacityReservationOptions$CapacityReservationPreference' => 'Indicates the instance\'s Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first
, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price
) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price
).
If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.
', ], ], 'OnDemandProvisioningAllocationStrategy' => [ 'base' => NULL, 'refs' => [ 'OnDemandProvisioningSpecification$AllocationStrategy' => 'Specifies the strategy to use in launching On-Demand instance fleets. Available options are lowest-price
and prioritized
. lowest-price
specifies to launch the instances with the lowest price first, and prioritized
specifies that Amazon EMR should launch the instances with the highest priority first. The default is lowest-price
.
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR releases 5.12.1 and later.
The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR releases 5.12.1 and later.
The resize specification for On-Demand Instances in the instance fleet, which contains the resize timeout period.
', 'refs' => [ 'InstanceFleetResizingSpecifications$OnDemandResizeSpecification' => 'The resize specification for On-Demand Instances in the instance fleet, which contains the resize timeout period.
', ], ], 'OptionalArnType' => [ 'base' => NULL, 'refs' => [ 'Cluster$OutpostArn' => 'The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
', 'ClusterSummary$OutpostArn' => 'The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
', 'Step$ExecutionRoleArn' => 'The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource
.
For example, arn:aws:IAM::1234567890:role/ReadOnly
is a correctly formatted runtime role ARN.
The output format for the notebook execution.
', 'StartNotebookExecutionInput$OutputNotebookFormat' => 'The output format for the notebook execution.
', ], ], 'OutputNotebookS3LocationForOutput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution output.
', 'refs' => [ 'NotebookExecution$OutputNotebookS3Location' => 'The Amazon S3 location for the notebook execution output.
', ], ], 'OutputNotebookS3LocationFromInput' => [ 'base' => 'The Amazon S3 location that stores the notebook execution output.
', 'refs' => [ 'StartNotebookExecutionInput$OutputNotebookS3Location' => 'The Amazon S3 location for the notebook execution output.
', ], ], 'PlacementGroupConfig' => [ 'base' => 'Placement group configuration for an Amazon EMR cluster. The configuration specifies the placement strategy that can be applied to instance roles during cluster creation.
To use this configuration, consider attaching managed policy AmazonElasticMapReducePlacementGroupPolicy to the Amazon EMR role.
', 'refs' => [ 'PlacementGroupConfigList$member' => NULL, ], ], 'PlacementGroupConfigList' => [ 'base' => NULL, 'refs' => [ 'Cluster$PlacementGroups' => 'Placement group configured for an Amazon EMR cluster.
', 'RunJobFlowInput$PlacementGroupConfigs' => 'The specified placement group configuration for an Amazon EMR cluster.
', ], ], 'PlacementGroupStrategy' => [ 'base' => NULL, 'refs' => [ 'PlacementGroupConfig$PlacementStrategy' => 'Amazon EC2 Placement Group strategy associated with instance role.
Starting with Amazon EMR release 5.23.0, the only supported placement strategy is SPREAD
for the MASTER
instance role.
The Amazon EC2 Availability Zone configuration of the cluster (job flow).
', 'refs' => [ 'JobFlowInstancesConfig$Placement' => 'The Availability Zone in which the cluster runs.
', 'JobFlowInstancesDetail$Placement' => 'The Amazon EC2 Availability Zone for the cluster.
', ], ], 'Port' => [ 'base' => NULL, 'refs' => [ 'PortRange$MinRange' => 'The smallest port number in a specified range of port numbers.
', 'PortRange$MaxRange' => 'The smallest port number in a specified range of port numbers.
', ], ], 'PortRange' => [ 'base' => 'A list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify a single port, use the same value for MinRange
and MaxRange
.
Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges
, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source.
By default, Port 22, which is used for SSH access to the cluster Amazon EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges
.
Type of reconfiguration requested. Valid values are MERGE and OVERWRITE.
', ], ], 'ReleaseLabelFilter' => [ 'base' => 'The release label filters by application or version prefix.
', 'refs' => [ 'ListReleaseLabelsInput$Filters' => 'Filters the results of the request. Prefix
specifies the prefix of release labels to return. Application
specifies the application (with/without version) of release labels to return.
This input identifies an Amazon EMR resource and a list of tags to remove.
', 'refs' => [], ], 'RemoveTagsOutput' => [ 'base' => 'This output indicates the result of removing tags from the resource.
', 'refs' => [], ], 'RepoUpgradeOnBoot' => [ 'base' => NULL, 'refs' => [ 'Cluster$RepoUpgradeOnBoot' => 'Applies only when CustomAmiID
is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.
Applies only when CustomAmiID
is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY
, which indicates that only security updates are applied. If NONE
is specified, no updates are applied, and all updates must be applied manually.
The Amazon EMR resource identifier to which tags will be added. For example, a cluster identifier or an Amazon EMR Studio ID.
', 'RemoveTagsInput$ResourceId' => 'The Amazon EMR resource identifier from which tags will be removed. For example, a cluster identifier or an Amazon EMR Studio ID.
', ], ], 'RunJobFlowInput' => [ 'base' => 'Input to the RunJobFlow operation.
', 'refs' => [], ], 'RunJobFlowOutput' => [ 'base' => 'The result of the RunJobFlow operation.
', 'refs' => [], ], 'ScaleDownBehavior' => [ 'base' => NULL, 'refs' => [ 'Cluster$ScaleDownBehavior' => 'The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
', 'refs' => [ 'ScalingRule$Action' => 'The conditions that trigger an automatic scaling activity.
', ], ], 'ScalingConstraints' => [ 'base' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits.
', 'refs' => [ 'AutoScalingPolicy$Constraints' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
', 'AutoScalingPolicyDescription$Constraints' => 'The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
', ], ], 'ScalingRule' => [ 'base' => 'A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how Amazon EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.
', 'refs' => [ 'ScalingRuleList$member' => NULL, ], ], 'ScalingRuleList' => [ 'base' => NULL, 'refs' => [ 'AutoScalingPolicy$Rules' => 'The scale-in and scale-out rules that comprise the automatic scaling policy.
', 'AutoScalingPolicyDescription$Rules' => 'The scale-in and scale-out rules that comprise the automatic scaling policy.
', ], ], 'ScalingTrigger' => [ 'base' => 'The conditions that trigger an automatic scaling activity.
', 'refs' => [ 'ScalingRule$Trigger' => 'The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
', ], ], 'ScriptBootstrapActionConfig' => [ 'base' => 'Configuration of the script to run during a bootstrap action.
', 'refs' => [ 'BootstrapActionConfig$ScriptBootstrapAction' => 'The script run by the bootstrap action.
', ], ], 'SecurityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListSecurityConfigurationsOutput$SecurityConfigurations' => 'The creation date and time, and name, of each security configuration.
', ], ], 'SecurityConfigurationSummary' => [ 'base' => 'The creation date and time, and name, of a security configuration.
', 'refs' => [ 'SecurityConfigurationList$member' => NULL, ], ], 'SecurityGroupsList' => [ 'base' => NULL, 'refs' => [ 'JobFlowInstancesConfig$AdditionalMasterSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the master node.
', 'JobFlowInstancesConfig$AdditionalSlaveSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the core and task nodes.
', ], ], 'SessionMappingDetail' => [ 'base' => 'Details for an Amazon EMR Studio session mapping including creation time, user or group ID, Studio ID, and so on.
', 'refs' => [ 'GetStudioSessionMappingOutput$SessionMapping' => 'The session mapping details for the specified Amazon EMR Studio and identity, including session policy ARN and creation time.
', ], ], 'SessionMappingSummary' => [ 'base' => 'Details for an Amazon EMR Studio session mapping. The details do not include the time the session mapping was last modified.
', 'refs' => [ 'SessionMappingSummaryList$member' => NULL, ], ], 'SessionMappingSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStudioSessionMappingsOutput$SessionMappings' => 'A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Amazon EMR Studio ID.
', ], ], 'SetKeepJobFlowAliveWhenNoStepsInput' => [ 'base' => NULL, 'refs' => [], ], 'SetTerminationProtectionInput' => [ 'base' => 'The input argument to the TerminationProtection operation.
', 'refs' => [], ], 'SetUnhealthyNodeReplacementInput' => [ 'base' => NULL, 'refs' => [], ], 'SetVisibleToAllUsersInput' => [ 'base' => 'The input to the SetVisibleToAllUsers action.
', 'refs' => [], ], 'ShrinkPolicy' => [ 'base' => 'Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.
', 'refs' => [ 'InstanceGroup$ShrinkPolicy' => 'Policy for customizing shrink operations.
', 'InstanceGroupModifyConfig$ShrinkPolicy' => 'Policy for customizing shrink operations.
', ], ], 'SimpleScalingPolicyConfiguration' => [ 'base' => 'An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of Amazon EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.
', 'refs' => [ 'ScalingAction$SimpleScalingPolicyConfiguration' => 'The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
', ], ], 'SimplifiedApplication' => [ 'base' => 'The returned release label application names or versions.
', 'refs' => [ 'SimplifiedApplicationList$member' => NULL, ], ], 'SimplifiedApplicationList' => [ 'base' => NULL, 'refs' => [ 'DescribeReleaseLabelOutput$Applications' => 'The list of applications available for the target release label. Name
is the name of the application. Version
is the concise version of the application.
Specifies one of the following strategies to launch Spot Instance fleets: capacity-optimized
, price-capacity-optimized
, lowest-price
, or diversified
, and capacity-optimized-prioritized
. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.
When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized
strategy. You can\'t change the allocation strategy from the old console.
The launch specification for Spot Instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is available in Amazon EMR releases 5.12.1 and later.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
', ], ], 'SpotProvisioningTimeoutAction' => [ 'base' => NULL, 'refs' => [ 'SpotProvisioningSpecification$TimeoutAction' => 'The action to take when TargetSpotCapacity
has not been fulfilled when the TimeoutDurationMinutes
has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER
and SWITCH_TO_ON_DEMAND
. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
The resize specification for Spot Instances in the instance fleet, which contains the resize timeout period.
', 'refs' => [ 'InstanceFleetResizingSpecifications$SpotResizeSpecification' => 'The resize specification for Spot Instances in the instance fleet, which contains the resize timeout period.
', ], ], 'StartNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StartNotebookExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'Statistic' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$Statistic' => 'The statistic to apply to the metric associated with the alarm. The default is AVERAGE
.
This represents a step in a cluster.
', 'refs' => [ 'DescribeStepOutput$Step' => 'The step details for the requested step identifier.
', ], ], 'StepCancellationOption' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInput$StepCancellationOption' => 'The option to choose to cancel RUNNING
steps. By default, the value is SEND_INTERRUPT
.
Specification for a cluster (job flow) step.
', 'refs' => [ 'StepConfigList$member' => NULL, 'StepDetail$StepConfig' => 'The step configuration.
', ], ], 'StepConfigList' => [ 'base' => NULL, 'refs' => [ 'AddJobFlowStepsInput$Steps' => 'A list of StepConfig to be executed by the job flow.
', 'RunJobFlowInput$Steps' => 'A list of steps to run.
', ], ], 'StepDetail' => [ 'base' => 'Combines the execution state and configuration of a step.
', 'refs' => [ 'StepDetailList$member' => NULL, ], ], 'StepDetailList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$Steps' => 'A list of steps run by the job flow.
', ], ], 'StepExecutionState' => [ 'base' => NULL, 'refs' => [ 'StepExecutionStatusDetail$State' => 'The state of the step.
', ], ], 'StepExecutionStatusDetail' => [ 'base' => 'The execution state of a step.
', 'refs' => [ 'StepDetail$ExecutionStatusDetail' => 'The description of the step status.
', ], ], 'StepId' => [ 'base' => NULL, 'refs' => [ 'CancelStepsInfo$StepId' => 'The encrypted StepId of a step.
', 'DescribeStepInput$StepId' => 'The identifier of the step to describe.
', 'Step$Id' => 'The identifier of the cluster step.
', 'StepSummary$Id' => 'The identifier of the cluster step.
', ], ], 'StepIdsList' => [ 'base' => NULL, 'refs' => [ 'AddJobFlowStepsOutput$StepIds' => 'The identifiers of the list of steps added to the job flow.
', 'CancelStepsInput$StepIds' => 'The list of StepIDs
to cancel. Use ListSteps to get steps and their states for the specified cluster.
The execution state of the cluster step.
', ], ], 'StepStateChangeReason' => [ 'base' => 'The details of the step state change reason.
', 'refs' => [ 'StepStatus$StateChangeReason' => 'The reason for the step execution status change.
', ], ], 'StepStateChangeReasonCode' => [ 'base' => NULL, 'refs' => [ 'StepStateChangeReason$Code' => 'The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.
', ], ], 'StepStateList' => [ 'base' => NULL, 'refs' => [ 'ListStepsInput$StepStates' => 'The filter to limit the step list based on certain states.
', ], ], 'StepStatus' => [ 'base' => 'The execution status details of the cluster step.
', 'refs' => [ 'Step$Status' => 'The current execution status details of the cluster step.
', 'StepSummary$Status' => 'The current execution status details of the cluster step.
', ], ], 'StepSummary' => [ 'base' => 'The summary of the cluster step.
', 'refs' => [ 'StepSummaryList$member' => NULL, ], ], 'StepSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStepsOutput$Steps' => 'The filtered list of steps for the cluster.
', ], ], 'StepTimeline' => [ 'base' => 'The timeline of the cluster step lifecycle.
', 'refs' => [ 'StepStatus$Timeline' => 'The timeline of the cluster step status over time.
', ], ], 'StopNotebookExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Application$Name' => 'The name of the application.
', 'Application$Version' => 'The version of the application.
', 'AutoScalingPolicyStateChangeReason$Message' => 'A friendly, more verbose message that accompanies an automatic scaling policy state change.
', 'CancelStepsInfo$Reason' => 'The reason for the failure if the CancelSteps request fails.
', 'CloudWatchAlarmDefinition$MetricName' => 'The name of the CloudWatch metric that is watched to determine an alarm condition.
', 'CloudWatchAlarmDefinition$Namespace' => 'The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce
.
The name of the cluster. This parameter can\'t contain the characters <, >, $, |, or ` (backtick).
', 'Cluster$LogUri' => 'The path to the Amazon S3 location where logs for this cluster are stored.
', 'Cluster$LogEncryptionKmsKeyId' => 'The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.
', 'Cluster$RequestedAmiVersion' => 'The AMI version requested for this cluster.
', 'Cluster$RunningAmiVersion' => 'The AMI version running on this cluster.
', 'Cluster$ReleaseLabel' => 'The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x
, where x.x.x is an Amazon EMR release version such as emr-5.14.0
. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion
.
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.
', 'Cluster$MasterPublicDnsName' => 'The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
', 'Cluster$OSReleaseLabel' => 'The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.
', 'ClusterStateChangeReason$Message' => 'The descriptive message for the state change reason.
', 'ClusterSummary$Name' => 'The name of the cluster.
', 'Command$Name' => 'The name of the command.
', 'Command$ScriptPath' => 'The Amazon S3 location of the command script.
', 'Configuration$Classification' => 'The classification within a configuration.
', 'CreateSecurityConfigurationInput$SecurityConfiguration' => 'The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
', 'DescribeReleaseLabelInput$ReleaseLabel' => 'The target release label to be described.
', 'DescribeReleaseLabelInput$NextToken' => 'The pagination token. Reserved for future use. Currently set to null.
', 'DescribeReleaseLabelOutput$ReleaseLabel' => 'The target release label described in the response.
', 'DescribeReleaseLabelOutput$NextToken' => 'The pagination token. Reserved for future use. Currently set to null.
', 'DescribeSecurityConfigurationOutput$SecurityConfiguration' => 'The security configuration details in JSON format.
', 'EbsBlockDevice$Device' => 'The device name that is exposed to the instance, such as /dev/sdh.
', 'EbsVolume$Device' => 'The device name that is exposed to the instance, such as /dev/sdh.
', 'EbsVolume$VolumeId' => 'The volume identifier of the EBS volume.
', 'Ec2InstanceAttributes$Ec2KeyName' => 'The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
', 'Ec2InstanceAttributes$Ec2SubnetId' => 'Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.
', 'Ec2InstanceAttributes$Ec2AvailabilityZone' => 'The Availability Zone in which the cluster will run.
', 'Ec2InstanceAttributes$IamInstanceProfile' => 'The IAM role that was specified when the cluster was launched. The Amazon EC2 instances of the cluster assume this role.
', 'Ec2InstanceAttributes$EmrManagedMasterSecurityGroup' => 'The identifier of the Amazon EC2 security group for the master node.
', 'Ec2InstanceAttributes$EmrManagedSlaveSecurityGroup' => 'The identifier of the Amazon EC2 security group for the core and task nodes.
', 'Ec2InstanceAttributes$ServiceAccessSecurityGroup' => 'The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
', 'ErrorDetail$ErrorCode' => 'The name or code associated with the error.
', 'ErrorDetail$ErrorMessage' => 'A message that describes the error.
', 'FailureDetails$Reason' => 'The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.
', 'FailureDetails$Message' => 'The descriptive message including the error the Amazon EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.
', 'FailureDetails$LogFile' => 'The path to the log file where the step failure root cause was originally recorded.
', 'HadoopStepConfig$Jar' => 'The path to the JAR file that runs during the step.
', 'HadoopStepConfig$MainClass' => 'The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
', 'Instance$PublicDnsName' => 'The public DNS name of the instance.
', 'Instance$PublicIpAddress' => 'The public IP address of the instance.
', 'Instance$PrivateDnsName' => 'The private DNS name of the instance.
', 'Instance$PrivateIpAddress' => 'The private IP address of the instance.
', 'Instance$InstanceGroupId' => 'The identifier of the instance group to which this instance belongs.
', 'InstanceFleetStateChangeReason$Message' => 'An explanatory message.
', 'InstanceGroup$Name' => 'The name of the instance group.
', 'InstanceGroup$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
The status change reason description.
', 'InstanceStateChangeReason$Message' => 'The status change reason description.
', 'ListReleaseLabelsInput$NextToken' => 'Specifies the next page of results. If NextToken
is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The ListReleaseLabels
request fails if the identity (Amazon Web Services account ID) and all filtering parameters are different from the original request, or if the NextToken
is expired or tampered with.
Used to paginate the next page of results if specified in the next ListReleaseLabels
request.
The Amazon EMR release label determines the versions of open-source application packages that Amazon EMR has installed on the cluster. Release labels are in the format emr-x.x.x
, where x.x.x is an Amazon EMR release number such as emr-6.10.0
. For more information about Amazon EMR releases and their included application versions and features, see the Amazon EMR Release Guide .
The pagination token that marks the next set of results to retrieve.
', 'ListSupportedInstanceTypesOutput$Marker' => 'The pagination token that marks the next set of results to retrieve.
', 'MetricDimension$Key' => 'The dimension name.
', 'MetricDimension$Value' => 'The dimension value.
', 'ModifyClusterInput$ClusterId' => 'The unique identifier of the cluster.
', 'OSRelease$Label' => 'The Amazon Linux release specified for a cluster in the RunJobFlow request. The format is as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
', 'ReleaseLabelFilter$Prefix' => 'Optional release label version prefix filter. For example, emr-5
.
Optional release label application filter. For example, spark@2.1.0
.
The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
', 'ScalingRule$Description' => 'A friendly, more verbose description of the automatic scaling rule.
', 'SimplifiedApplication$Name' => 'The returned release label application name. For example, hadoop
.
The returned release label application version. For example, 3.2.1
.
The name of the cluster step.
', 'StepStateChangeReason$Message' => 'The descriptive message for the state change reason.
', 'StepSummary$Name' => 'The name of the cluster step.
', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubnetIdList$member' => NULL, 'SupportedInstanceType$Type' => 'The Amazon EC2 instance type, for example m5.xlarge
, of the SupportedInstanceType
.
The Amazon EC2 family and generation for the SupportedInstanceType
.
The CPU architecture, for example X86_64
or AARCH64
.
A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag.
', 'Tag$Value' => 'A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
', 'VolumeSpecification$VolumeType' => 'The volume type. Volume types supported are gp3, gp2, io1, st1, sc1, and standard.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'Application$Args' => 'Arguments for Amazon EMR to pass to the application.
', 'Command$Args' => 'Arguments for Amazon EMR to pass to the command for execution.
', 'Ec2InstanceAttributes$AdditionalMasterSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the master node.
', 'Ec2InstanceAttributes$AdditionalSlaveSecurityGroups' => 'A list of additional Amazon EC2 security group IDs for the core and task nodes.
', 'HadoopStepConfig$Args' => 'The list of command line arguments to pass to the JAR file\'s main function for execution.
', 'ListReleaseLabelsOutput$ReleaseLabels' => 'The returned release labels.
', 'RemoveTagsInput$TagKeys' => 'A list of tag keys to remove from the resource.
', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'Application$AdditionalInfo' => 'This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
', 'Configuration$Properties' => 'A set of properties specified within a configuration classification.
', 'ErrorData$member' => NULL, 'HadoopStepConfig$Properties' => 'The list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.
', ], ], 'Studio' => [ 'base' => 'Details for an Amazon EMR Studio including ID, creation time, name, and so on.
', 'refs' => [ 'DescribeStudioOutput$Studio' => 'The Amazon EMR Studio details.
', ], ], 'StudioSummary' => [ 'base' => 'Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. To fetch additional details such as subnets, IAM roles, security groups, and tags for the Studio, use the DescribeStudio API.
', 'refs' => [ 'StudioSummaryList$member' => NULL, ], ], 'StudioSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListStudiosOutput$Studios' => 'The list of Studio summary objects.
', ], ], 'SubnetIdList' => [ 'base' => NULL, 'refs' => [ 'CreateStudioInput$SubnetIds' => 'A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId
. Studio users can create a Workspace in any of the specified subnets.
The list of IDs of the subnets associated with the Amazon EMR Studio.
', 'UpdateStudioInput$SubnetIds' => 'A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio.
', ], ], 'SupportedInstanceType' => [ 'base' => 'An instance type that the specified Amazon EMR release supports.
', 'refs' => [ 'SupportedInstanceTypesList$member' => NULL, ], ], 'SupportedInstanceTypesList' => [ 'base' => NULL, 'refs' => [ 'ListSupportedInstanceTypesOutput$SupportedInstanceTypes' => 'The list of instance types that the release specified in ListSupportedInstanceTypesInput$ReleaseLabel
supports, filtered by Amazon Web Services Region.
The list of supported product configurations that allow user-supplied arguments. Amazon EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.
', 'refs' => [ 'NewSupportedProductsList$member' => NULL, ], ], 'SupportedProductsList' => [ 'base' => NULL, 'refs' => [ 'JobFlowDetail$SupportedProducts' => 'A list of strings set by third-party software when the job flow is launched. If you are not using third-party software to manage the job flow, this value is empty.
', 'RunJobFlowInput$SupportedProducts' => 'For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.
A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:
"mapr-m3" - launch the job flow using MapR M3 Edition.
"mapr-m5" - launch the job flow using MapR M5 Edition.
A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$Tags' => 'A list of tags to associate with a resource. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
', 'Cluster$Tags' => 'A list of tags associated with a cluster.
', 'CreateStudioInput$Tags' => 'A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
', 'NotebookExecution$Tags' => 'A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
', 'RunJobFlowInput$Tags' => 'A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
', 'StartNotebookExecutionInput$Tags' => 'A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
', 'Studio$Tags' => 'A list of tags associated with the Amazon EMR Studio.
', ], ], 'TerminateJobFlowsInput' => [ 'base' => 'Input to the TerminateJobFlows operation.
', 'refs' => [], ], 'ThroughputVal' => [ 'base' => NULL, 'refs' => [ 'VolumeSpecification$Throughput' => 'The throughput, in mebibyte per second (MiB/s). This optional parameter can be a number from 125 - 1000 and is valid only for gp3 volumes.
', ], ], 'Unit' => [ 'base' => NULL, 'refs' => [ 'CloudWatchAlarmDefinition$Unit' => 'The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit
must correspond to the units specified in the CloudWatch metric.
The key to the Amazon S3 location that stores the notebook execution input.
', 'NotebookS3LocationFromInput$Key' => 'The key to the Amazon S3 location that stores the notebook execution input.
', 'OutputNotebookS3LocationForOutput$Key' => 'The key to the Amazon S3 location that stores the notebook execution output.
', 'OutputNotebookS3LocationFromInput$Key' => 'The key to the Amazon S3 location that stores the notebook execution output.
', ], ], 'UsernamePassword' => [ 'base' => 'The username and password that you use to connect to cluster endpoints.
', 'refs' => [ 'Credentials$UsernamePassword' => 'The username and password that you use to connect to cluster endpoints.
', ], ], 'VolumeSpecification' => [ 'base' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', 'refs' => [ 'EbsBlockDevice$VolumeSpecification' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', 'EbsBlockDeviceConfig$VolumeSpecification' => 'EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
', ], ], 'WholeNumber' => [ 'base' => NULL, 'refs' => [ 'InstanceFleet$TargetOnDemandCapacity' => 'The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When an On-Demand Instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.
If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity
. At least one of TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be 1.
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When a Spot instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.
If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be 1.
The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity
. This provisioned capacity might be less than or greater than TargetOnDemandCapacity
.
The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity
. This provisioned capacity might be less than or greater than TargetSpotCapacity
.
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When an On-Demand Instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity
. At least one of TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be 1.
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity
. When a Spot Instance is provisioned, the WeightedCapacity
units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.
If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity
and TargetOnDemandCapacity
should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity
and TargetOnDemandCapacity
can be specified, and its value must be 1.
The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.
', 'InstanceFleetModifyConfig$TargetSpotCapacity' => 'The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.
', 'InstanceTypeConfig$WeightedCapacity' => 'The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.
', 'InstanceTypeSpecification$WeightedCapacity' => 'The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.
', 'OnDemandResizingSpecification$TimeoutDurationMinutes' => 'On-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
', 'SpotProvisioningSpecification$TimeoutDurationMinutes' => 'The Spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction
is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
Spot resize timeout in minutes. If Spot Instances are not provisioned within this time, the resize workflow will stop provisioning of Spot instances. Minimum value is 5 minutes and maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
', ], ], 'XmlString' => [ 'base' => NULL, 'refs' => [ 'Cluster$SecurityConfiguration' => 'The name of the security configuration applied to the cluster.
', 'Cluster$AutoScalingRole' => 'An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
The name of the security configuration.
', 'CreateSecurityConfigurationOutput$Name' => 'The name of the security configuration.
', 'CreateStudioInput$ServiceRole' => 'The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
', 'CreateStudioInput$UserRole' => 'The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole
when you use IAM Identity Center authentication. The permissions attached to the UserRole
can be scoped down for each user or group using session policies.
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
', 'CreateStudioInput$IdpAuthUrl' => 'The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
', 'CreateStudioInput$EncryptionKeyArn' => 'The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
', 'CreateStudioOutput$Url' => 'The unique Studio access URL.
', 'DeleteSecurityConfigurationInput$Name' => 'The name of the security configuration.
', 'DescribeSecurityConfigurationInput$Name' => 'The name of the security configuration.
', 'DescribeSecurityConfigurationOutput$Name' => 'The name of the security configuration.
', 'EnvironmentVariablesMap$value' => NULL, 'HadoopJarStepConfig$Jar' => 'A path to a JAR file run during the step.
', 'HadoopJarStepConfig$MainClass' => 'The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
', 'InstanceGroupDetail$LastStateChangeReason' => 'Details regarding the state of the instance group.
', 'JobFlowDetail$LogUri' => 'The location in Amazon S3 where log files for the job are stored.
', 'JobFlowDetail$LogEncryptionKmsKeyId' => 'The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding 6.0.0.
', 'JobFlowDetail$JobFlowRole' => 'The IAM role that was specified when the job flow was launched. The Amazon EC2 instances of the job flow assume this role.
', 'JobFlowDetail$ServiceRole' => 'The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.
', 'JobFlowDetail$AutoScalingRole' => 'An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate Amazon EC2 instances in an instance group.
Description of the job flow last changed state.
', 'JobFlowInstancesDetail$MasterPublicDnsName' => 'The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
', 'JobFlowInstancesDetail$MasterInstanceId' => 'The Amazon EC2 instance identifier of the master node.
', 'KeyValue$Key' => 'The unique identifier of a key-value pair.
', 'KeyValue$Value' => 'The value part of the identified key.
', 'ListNotebookExecutionsInput$ExecutionEngineId' => 'The unique ID of the execution engine.
', 'NotebookExecution$NotebookParams' => 'Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
', 'NotebookExecution$OutputNotebookURI' => 'The location of the notebook execution\'s output file in Amazon S3.
', 'NotebookExecution$LastStateChangeReason' => 'The reason for the latest status change of the notebook execution.
', 'NotebookExecutionSummary$ExecutionEngineId' => 'The unique ID of the execution engine for the notebook execution.
', 'PlacementType$AvailabilityZone' => 'The Amazon EC2 Availability Zone for the cluster. AvailabilityZone
is used for uniform instance groups, while AvailabilityZones
(plural) is used for instance fleets.
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
', 'RunJobFlowInput$LogEncryptionKmsKeyId' => 'The KMS key used for encrypting log files. If a value is not provided, the logs remain encrypted by AES-256. This attribute is only available with Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
', 'RunJobFlowInput$AdditionalInfo' => 'A JSON string for selecting additional features.
', 'RunJobFlowInput$JobFlowRole' => 'Also called instance profile and Amazon EC2 role. An IAM role for an Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole
. In order to use the default role, you must have already created it using the CLI or console.
The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf. If you\'ve created a custom service role path, you must specify it for the service role when you launch your cluster.
', 'RunJobFlowInput$SecurityConfiguration' => 'The name of a security configuration to apply to the cluster.
', 'RunJobFlowInput$AutoScalingRole' => 'An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.
Location in Amazon S3 of the script to run during a bootstrap action.
', 'SecurityConfigurationSummary$Name' => 'The name of the security configuration.
', 'StartNotebookExecutionInput$RelativePath' => 'The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks
when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD
(the EditorID
of this request), and you specify a RelativePath
of my_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
', 'StartNotebookExecutionInput$ServiceRole' => 'The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
', 'StepExecutionStatusDetail$LastStateChangeReason' => 'A description of the step\'s current state.
', 'Studio$ServiceRole' => 'The name of the IAM role assumed by the Amazon EMR Studio.
', 'Studio$UserRole' => 'The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole
when you use IAM authentication.
The unique access URL of the Amazon EMR Studio.
', 'Studio$DefaultS3Location' => 'The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
', 'Studio$IdpAuthUrl' => 'Your identity provider\'s authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
', 'Studio$EncryptionKeyArn' => 'The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
', 'UpdateStudioInput$DefaultS3Location' => 'The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.
', 'UpdateStudioInput$EncryptionKeyArn' => 'The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
', 'XmlStringList$member' => NULL, ], ], 'XmlStringList' => [ 'base' => NULL, 'refs' => [ 'DescribeJobFlowsInput$JobFlowIds' => 'Return only job flows whose job flow ID is contained in this list.
', 'HadoopJarStepConfig$Args' => 'A list of command line arguments passed to the JAR file\'s main function when executed.
', 'ListStepsInput$StepIds' => 'The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.
', 'ScriptBootstrapActionConfig$Args' => 'A list of command line arguments to pass to the bootstrap action script.
', 'SetKeepJobFlowAliveWhenNoStepsInput$JobFlowIds' => 'A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows.
', 'SetTerminationProtectionInput$JobFlowIds' => 'A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
', 'SetUnhealthyNodeReplacementInput$JobFlowIds' => 'The list of strings that uniquely identify the clusters for which to turn on unhealthy node replacement. You can get these identifiers by running the RunJobFlow or the DescribeJobFlows operations.
', 'SetVisibleToAllUsersInput$JobFlowIds' => 'The unique identifier of the job flow (cluster).
', 'SupportedProductConfig$Args' => 'The list of user-supplied arguments.
', 'TerminateJobFlowsInput$JobFlowIds' => 'A list of job flows to be shut down.
', ], ], 'XmlStringMaxLen256' => [ 'base' => NULL, 'refs' => [ 'AddInstanceFleetInput$ClusterId' => 'The unique identifier of the cluster.
', 'AddInstanceFleetOutput$ClusterId' => 'The unique identifier of the cluster.
', 'AddInstanceGroupsInput$JobFlowId' => 'Job flow in which to add the instance groups.
', 'AddInstanceGroupsOutput$JobFlowId' => 'The job flow ID in which the instance groups are added.
', 'AddJobFlowStepsInput$JobFlowId' => 'A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.
', 'BootstrapActionConfig$Name' => 'The name of the bootstrap action.
', 'CancelStepsInput$ClusterId' => 'The ClusterID
for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
', 'CreateStudioInput$Name' => 'A descriptive name for the Amazon EMR Studio.
', 'CreateStudioInput$Description' => 'A detailed description of the Amazon EMR Studio.
', 'CreateStudioInput$VpcId' => 'The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
', 'CreateStudioInput$WorkspaceSecurityGroupId' => 'The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId
.
The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId
.
The name that your identity provider (IdP) uses for its RelayState
parameter. For example, RelayState
or TargetSource
. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState
parameter differs by IdP.
The ID of the Amazon EMR Studio.
', 'CreateStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio to which the user or group will be mapped.
', 'CreateStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified, but not both.
The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified, but not both.
The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an Amazon EMR Studio User Role with Session Policies.
', 'DeleteStudioInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'DeleteStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'DeleteStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
The name of the user name or group to remove from the Amazon EMR Studio. For more information, see UserName and DisplayName in the IAM Identity Center Store API Reference. Either IdentityName
or IdentityId
must be specified.
The unique identifier of the notebook execution.
', 'DescribeStudioInput$StudioId' => 'The Amazon EMR Studio ID.
', 'EnvironmentVariablesMap$key' => NULL, 'ExecutionEngineConfig$Id' => 'The unique identifier of the execution engine. For an Amazon EMR cluster, this is the cluster ID.
', 'ExecutionEngineConfig$MasterInstanceSecurityGroupId' => 'An optional unique ID of an Amazon EC2 security group to associate with the master instance of the Amazon EMR cluster for this notebook execution. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the EMR Management Guide.
', 'GetClusterSessionCredentialsInput$ClusterId' => 'The unique identifier of the cluster.
', 'GetStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'GetStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
The name of the user or group to fetch. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
A friendly name for the instance fleet.
', 'InstanceFleetConfig$Name' => 'The friendly name of the instance fleet.
', 'InstanceGroup$CustomAmiId' => 'The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupConfig$Name' => 'Friendly name given to the instance group.
', 'InstanceGroupConfig$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupDetail$InstanceGroupId' => 'Unique identifier for the instance group.
', 'InstanceGroupDetail$Name' => 'Friendly name for the instance group.
', 'InstanceGroupDetail$BidPrice' => 'If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.
The custom AMI ID to use for the provisioned instance group.
', 'InstanceGroupIdsList$member' => NULL, 'InstanceGroupModifyConfig$InstanceGroupId' => 'Unique ID of the instance group to modify.
', 'InstanceTypeConfig$BidPrice' => 'The bid price for each Amazon EC2 Spot Instance type as defined by InstanceType
. Expressed in USD. If neither BidPrice
nor BidPriceAsPercentageOfOnDemandPrice
is provided, BidPriceAsPercentageOfOnDemandPrice
defaults to 100%.
The custom AMI ID to use for the instance type.
', 'InstanceTypeSpecification$BidPrice' => 'The bid price for each Amazon EC2 Spot Instance type as defined by InstanceType
. Expressed in USD.
The custom AMI ID to use for the instance type.
', 'JobFlowDetail$JobFlowId' => 'The job flow identifier.
', 'JobFlowDetail$Name' => 'The name of the job flow.
', 'JobFlowDetail$AmiVersion' => 'Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
The name of the Amazon EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop."
', 'JobFlowInstancesConfig$HadoopVersion' => 'Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion
parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.
', 'JobFlowInstancesConfig$EmrManagedMasterSecurityGroup' => 'The identifier of the Amazon EC2 security group for the master node. If you specify EmrManagedMasterSecurityGroup
, you must also specify EmrManagedSlaveSecurityGroup
.
The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup
, you must also specify EmrManagedMasterSecurityGroup
.
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
', 'JobFlowInstancesDetail$Ec2KeyName' => 'The name of an Amazon EC2 key pair that can be used to connect to the master node using SSH.
', 'JobFlowInstancesDetail$Ec2SubnetId' => 'For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.
', 'JobFlowInstancesDetail$HadoopVersion' => 'The Hadoop version for the cluster.
', 'KerberosAttributes$Realm' => 'The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL
.
The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.
', 'KerberosAttributes$CrossRealmTrustPrincipalPassword' => 'Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.
', 'KerberosAttributes$ADDomainJoinUser' => 'Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.
', 'KerberosAttributes$ADDomainJoinPassword' => 'The Active Directory password for ADDomainJoinUser
.
The unique ID of the editor associated with the notebook execution.
', 'ListStudioSessionMappingsInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'NotebookExecution$NotebookExecutionId' => 'The unique identifier of a notebook execution.
', 'NotebookExecution$EditorId' => 'The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
', 'NotebookExecution$NotebookExecutionName' => 'A name for the notebook execution.
', 'NotebookExecution$Arn' => 'The Amazon Resource Name (ARN) of the notebook execution.
', 'NotebookExecution$NotebookInstanceSecurityGroupId' => 'The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
', 'NotebookExecutionSummary$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'NotebookExecutionSummary$EditorId' => 'The unique identifier of the editor associated with the notebook execution.
', 'NotebookExecutionSummary$NotebookExecutionName' => 'The name of the notebook execution.
', 'NotebookS3LocationForOutput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution input.
', 'NotebookS3LocationFromInput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution input.
', 'OnDemandCapacityReservationOptions$CapacityReservationResourceGroupArn' => 'The ARN of the Capacity Reservation resource group in which to run the instance.
', 'OutputNotebookS3LocationForOutput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution output.
', 'OutputNotebookS3LocationFromInput$Bucket' => 'The Amazon S3 bucket that stores the notebook execution output.
', 'RunJobFlowInput$Name' => 'The name of the job flow.
', 'RunJobFlowInput$AmiVersion' => 'Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel
is used. To specify a custom AMI, use CustomAmiID
.
The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x
, where x.x.x is an Amazon EMR release version such as emr-5.14.0
. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion
.
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster Amazon EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel
specified. For Amazon EMR releases 2.x and 3.x, use AmiVersion
instead.
For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.
', 'RunJobFlowInput$OSReleaseLabel' => 'Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.
', 'RunJobFlowOutput$JobFlowId' => 'A unique identifier for the job flow.
', 'SecurityGroupsList$member' => NULL, 'SessionMappingDetail$StudioId' => 'The ID of the Amazon EMR Studio.
', 'SessionMappingDetail$IdentityId' => 'The globally unique identifier (GUID) of the user or group.
', 'SessionMappingDetail$IdentityName' => 'The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.
', 'SessionMappingDetail$SessionPolicyArn' => 'The Amazon Resource Name (ARN) of the session policy associated with the user or group.
', 'SessionMappingSummary$StudioId' => 'The ID of the Amazon EMR Studio.
', 'SessionMappingSummary$IdentityId' => 'The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store.
', 'SessionMappingSummary$IdentityName' => 'The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.
', 'SessionMappingSummary$SessionPolicyArn' => 'The Amazon Resource Name (ARN) of the session policy associated with the user or group.
', 'StartNotebookExecutionInput$EditorId' => 'The unique identifier of the Amazon EMR Notebook to use for notebook execution.
', 'StartNotebookExecutionInput$NotebookExecutionName' => 'An optional name for the notebook execution.
', 'StartNotebookExecutionInput$NotebookInstanceSecurityGroupId' => 'The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
', 'StartNotebookExecutionOutput$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'StepConfig$Name' => 'The name of the step.
', 'StepIdsList$member' => NULL, 'StopNotebookExecutionInput$NotebookExecutionId' => 'The unique identifier of the notebook execution.
', 'Studio$StudioId' => 'The ID of the Amazon EMR Studio.
', 'Studio$StudioArn' => 'The Amazon Resource Name (ARN) of the Amazon EMR Studio.
', 'Studio$Name' => 'The name of the Amazon EMR Studio.
', 'Studio$Description' => 'The detailed description of the Amazon EMR Studio.
', 'Studio$VpcId' => 'The ID of the VPC associated with the Amazon EMR Studio.
', 'Studio$WorkspaceSecurityGroupId' => 'The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
', 'Studio$EngineSecurityGroupId' => 'The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.
', 'Studio$IdpRelayStateParameterName' => 'The name of your identity provider\'s RelayState
parameter.
The ID of the Amazon EMR Studio.
', 'StudioSummary$Name' => 'The name of the Amazon EMR Studio.
', 'StudioSummary$VpcId' => 'The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.
', 'StudioSummary$Description' => 'The detailed description of the Amazon EMR Studio.
', 'StudioSummary$Url' => 'The unique access URL of the Amazon EMR Studio.
', 'SupportedProductConfig$Name' => 'The name of the product configuration.
', 'SupportedProductsList$member' => NULL, 'UpdateStudioInput$StudioId' => 'The ID of the Amazon EMR Studio to update.
', 'UpdateStudioInput$Name' => 'A descriptive name for the Amazon EMR Studio.
', 'UpdateStudioInput$Description' => 'A detailed description to assign to the Amazon EMR Studio.
', 'UpdateStudioSessionMappingInput$StudioId' => 'The ID of the Amazon EMR Studio.
', 'UpdateStudioSessionMappingInput$IdentityId' => 'The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
The name of the user or group to update. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName
or IdentityId
must be specified.
The Amazon Resource Name (ARN) of the session policy to associate with the specified user or group.
', 'UsernamePassword$Username' => 'The username associated with the temporary credentials that you use to connect to cluster endpoints.
', 'UsernamePassword$Password' => 'The password associated with the temporary credentials that you use to connect to cluster endpoints.
', 'XmlStringMaxLen256List$member' => NULL, ], ], 'XmlStringMaxLen256List' => [ 'base' => NULL, 'refs' => [ 'Ec2InstanceAttributes$RequestedEc2SubnetIds' => 'Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the Amazon EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds
, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones
instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot be specified together.
Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch Amazon EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones
, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs
and RequestedEc2AvailabilityZones
cannot be specified together.
Applies to clusters that use the instance fleet configuration. When multiple Amazon EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones
is used for instance fleets, while AvailabilityZone
(singular) is used for uniform instance groups.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The definition of the specified database in the Data Catalog.
" } }, + "DatabaseAttributes": { + "base": null, + "refs": { + "DatabaseAttributesList$member": null + } + }, + "DatabaseAttributesList": { + "base": null, + "refs": { + "GetDatabasesRequest$AttributesToGet": "Specifies the database fields returned by the GetDatabases
call. This parameter doesn’t accept an empty list. The request must include the NAME
.
A structure that describes a target database for resource linking.
", "refs": { diff --git a/src/data/glue/2017-03-31/docs-2.json.php b/src/data/glue/2017-03-31/docs-2.json.php index 37822f1e8a..46ebcfe23d 100644 --- a/src/data/glue/2017-03-31/docs-2.json.php +++ b/src/data/glue/2017-03-31/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Defines the public endpoint for the Glue service.
', 'operations' => [ 'BatchCreatePartition' => 'Creates one or more partitions in a batch operation.
', 'BatchDeleteConnection' => 'Deletes a list of connection definitions from the Data Catalog.
', 'BatchDeletePartition' => 'Deletes one or more partitions in a batch operation.
', 'BatchDeleteTable' => 'Deletes multiple tables at once.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling BatchDeleteTable
, use DeleteTableVersion
or BatchDeleteTableVersion
, and DeletePartition
or BatchDeletePartition
, to delete any resources that belong to the table.
Deletes a specified batch of versions of a table.
', 'BatchGetBlueprints' => 'Retrieves information about a list of blueprints.
', 'BatchGetCrawlers' => 'Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves the details for the custom patterns specified by a list of names.
', 'BatchGetDataQualityResult' => 'Retrieves a list of data quality results for the specified result IDs.
', 'BatchGetDevEndpoints' => 'Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of job names. After calling the ListJobs
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves partitions in a batch request.
', 'BatchGetTableOptimizer' => 'Returns the configuration for the specified table optimizers.
', 'BatchGetTriggers' => 'Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Stops one or more job runs for a specified job definition.
', 'BatchUpdatePartition' => 'Updates one or more partitions in a batch operation.
', 'CancelDataQualityRuleRecommendationRun' => 'Cancels the specified recommendation run that was being used to generate rules.
', 'CancelDataQualityRulesetEvaluationRun' => 'Cancels a run where a ruleset is being evaluated against a data source.
', 'CancelMLTaskRun' => 'Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun
with a task run\'s parent transform\'s TransformID
and the task run\'s TaskRunId
.
Cancels the statement.
', 'CheckSchemaVersionValidity' => 'Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat
as the format. Since it does not take a schema set name, no compatibility checks are performed.
Registers a blueprint with Glue.
', 'CreateClassifier' => 'Creates a classifier in the user\'s account. This can be a GrokClassifier
, an XMLClassifier
, a JsonClassifier
, or a CsvClassifier
, depending on which field of the request is present.
Creates a connection definition in the Data Catalog.
Connections used for creating federated resources require the IAM glue:PassConnection
permission.
Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets
field, the jdbcTargets
field, or the DynamoDBTargets
field.
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.
', 'CreateDataQualityRuleset' => 'Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.
', 'CreateDatabase' => 'Creates a new database in a Data Catalog.
', 'CreateDevEndpoint' => 'Creates a new development endpoint.
', 'CreateJob' => 'Creates a new job definition.
', 'CreateMLTransform' => 'Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.
Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches
transform) for deduplicating data. You can provide an optional Description
, in addition to the parameters that you want to use for your algorithm.
You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include Role
, and optionally, AllocatedCapacity
, Timeout
, and MaxRetries
. For more information, see Jobs.
Creates a new partition.
', 'CreatePartitionIndex' => 'Creates a specified partition index in an existing table.
', 'CreateRegistry' => 'Creates a new registry which may be used to hold a collection of schemas.
', 'CreateSchema' => 'Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.
When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion
API is used.
When this API is called without a RegistryId
, this will create an entry for a "default-registry" in the registry database tables, if it is not already present.
Transforms a directed acyclic graph (DAG) into code.
', 'CreateSecurityConfiguration' => 'Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.
', 'CreateSession' => 'Creates a new session.
', 'CreateTable' => 'Creates a new table definition in the Data Catalog.
', 'CreateTableOptimizer' => 'Creates a new table optimizer for a specific function. compaction
is the only currently supported optimizer type.
Creates a new trigger.
', 'CreateUsageProfile' => 'Creates an Glue usage profile.
', 'CreateUserDefinedFunction' => 'Creates a new function definition in the Data Catalog.
', 'CreateWorkflow' => 'Creates a new workflow.
', 'DeleteBlueprint' => 'Deletes an existing blueprint.
', 'DeleteClassifier' => 'Removes a classifier from the Data Catalog.
', 'DeleteColumnStatisticsForPartition' => 'Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is DeletePartition
.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is DeleteTable
.
Deletes a connection from the Data Catalog.
', 'DeleteCrawler' => 'Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING
.
Deletes a custom pattern by specifying its name.
', 'DeleteDataQualityRuleset' => 'Deletes a data quality ruleset.
', 'DeleteDatabase' => 'Removes a specified database from a Data Catalog.
After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteDatabase
, use DeleteTableVersion
or BatchDeleteTableVersion
, DeletePartition
or BatchDeletePartition
, DeleteUserDefinedFunction
, and DeleteTable
or BatchDeleteTable
, to delete any resources that belong to the database.
Deletes a specified development endpoint.
', 'DeleteJob' => 'Deletes a specified job definition. If the job definition is not found, no exception is thrown.
', 'DeleteMLTransform' => 'Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms
. However, any Glue jobs that still reference the deleted transform will no longer succeed.
Deletes a specified partition.
', 'DeletePartitionIndex' => 'Deletes a specified partition index from an existing table.
', 'DeleteRegistry' => 'Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry
API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry
, CreateSchema
, UpdateSchema
, and RegisterSchemaVersion
APIs.
Deletes a specified policy.
', 'DeleteSchema' => 'Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema
API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition
, and RegisterSchemaVersion
APIs.
Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions
API after this call will list the status of the deleted versions.
When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint
API before using this API.
You cannot use the DeleteSchemaVersions
API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema
API. This operation will also delete the attached SchemaVersionMetadata
under the schema versions. Hard deletes will be enforced on the database.
If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
', 'DeleteSecurityConfiguration' => 'Deletes a specified security configuration.
', 'DeleteSession' => 'Deletes the session.
', 'DeleteTable' => 'Removes a table definition from the Data Catalog.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteTable
, use DeleteTableVersion
or BatchDeleteTableVersion
, and DeletePartition
or BatchDeletePartition
, to delete any resources that belong to the table.
Deletes an optimizer and all associated metadata for a table. The optimization will no longer be performed on the table.
', 'DeleteTableVersion' => 'Deletes a specified version of a table.
', 'DeleteTrigger' => 'Deletes a specified trigger. If the trigger is not found, no exception is thrown.
', 'DeleteUsageProfile' => 'Deletes the Glue specified usage profile.
', 'DeleteUserDefinedFunction' => 'Deletes an existing function definition from the Data Catalog.
', 'DeleteWorkflow' => 'Deletes a workflow.
', 'GetBlueprint' => 'Retrieves the details of a blueprint.
', 'GetBlueprintRun' => 'Retrieves the details of a blueprint run.
', 'GetBlueprintRuns' => 'Retrieves the details of blueprint runs for a specified blueprint.
', 'GetCatalogImportStatus' => 'Retrieves the status of a migration operation.
', 'GetClassifier' => 'Retrieve a classifier by name.
', 'GetClassifiers' => 'Lists all classifier objects in the Data Catalog.
', 'GetColumnStatisticsForPartition' => 'Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetPartition
.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetTable
.
Get the associated metadata/information for a task run, given a task run ID.
', 'GetColumnStatisticsTaskRuns' => 'Retrieves information about all runs associated with the specified table.
', 'GetConnection' => 'Retrieves a connection definition from the Data Catalog.
', 'GetConnections' => 'Retrieves a list of connection definitions from the Data Catalog.
', 'GetCrawler' => 'Retrieves metadata for a specified crawler.
', 'GetCrawlerMetrics' => 'Retrieves metrics about specified crawlers.
', 'GetCrawlers' => 'Retrieves metadata for all crawlers defined in the customer account.
', 'GetCustomEntityType' => 'Retrieves the details of a custom pattern by specifying its name.
', 'GetDataCatalogEncryptionSettings' => 'Retrieves the security configuration for a specified catalog.
', 'GetDataQualityResult' => 'Retrieves the result of a data quality rule evaluation.
', 'GetDataQualityRuleRecommendationRun' => 'Gets the specified recommendation run that was used to generate rules.
', 'GetDataQualityRuleset' => 'Returns an existing ruleset by identifier or name.
', 'GetDataQualityRulesetEvaluationRun' => 'Retrieves a specific run where a ruleset is evaluated against a data source.
', 'GetDatabase' => 'Retrieves the definition of a specified database.
', 'GetDatabases' => 'Retrieves all databases defined in a given Data Catalog.
', 'GetDataflowGraph' => 'Transforms a Python script into a directed acyclic graph (DAG).
', 'GetDevEndpoint' => 'Retrieves information about a specified development endpoint.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves all the development endpoints in this Amazon Web Services account.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves an existing job definition.
', 'GetJobBookmark' => 'Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
', 'GetJobRun' => 'Retrieves the metadata for a given job run. Job run history is accessible for 90 days for your workflow and job run.
', 'GetJobRuns' => 'Retrieves metadata for all runs of a given job definition.
', 'GetJobs' => 'Retrieves all current job definitions.
', 'GetMLTaskRun' => 'Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun
with the TaskRunID
and its parent transform\'s TransformID
.
Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns
with their parent transform\'s TransformID
and other optional parameters as documented in this section.
This operation returns a list of historic runs and must be paginated.
', 'GetMLTransform' => 'Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform
.
Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling GetMLTransforms
.
Creates mappings.
', 'GetPartition' => 'Retrieves information about a specified partition.
', 'GetPartitionIndexes' => 'Retrieves the partition indexes associated with a table.
', 'GetPartitions' => 'Retrieves information about the partitions in a table.
', 'GetPlan' => 'Gets code to perform a specified mapping.
', 'GetRegistry' => 'Describes the specified registry in detail.
', 'GetResourcePolicies' => 'Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.
If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can\'t return the Data Catalog resource policy.
', 'GetResourcePolicy' => 'Retrieves a specified resource policy.
', 'GetSchema' => 'Describes the specified schema in detail.
', 'GetSchemaByDefinition' => 'Retrieves a schema by the SchemaDefinition
. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName
or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted
statuses will not be included in the results.
Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.
', 'GetSchemaVersionsDiff' => 'Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
', 'GetSecurityConfiguration' => 'Retrieves a specified security configuration.
', 'GetSecurityConfigurations' => 'Retrieves a list of all security configurations.
', 'GetSession' => 'Retrieves the session.
', 'GetStatement' => 'Retrieves the statement.
', 'GetTable' => 'Retrieves the Table
definition in a Data Catalog for a specified table.
Returns the configuration of all optimizers associated with a specified table.
', 'GetTableVersion' => 'Retrieves a specified version of a table.
', 'GetTableVersions' => 'Retrieves a list of strings that identify available versions of a specified table.
', 'GetTables' => 'Retrieves the definitions of some or all of the tables in a given Database
.
Retrieves a list of tags associated with a resource.
', 'GetTrigger' => 'Retrieves the definition of a trigger.
', 'GetTriggers' => 'Gets all the triggers associated with a job.
', 'GetUnfilteredPartitionMetadata' => 'Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetPartition
.
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetPartitions
.
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
For IAM authorization, the public IAM action associated with this API is glue:GetTable
.
Retrieves information about the specified Glue usage profile.
', 'GetUserDefinedFunction' => 'Retrieves a specified function definition from the Data Catalog.
', 'GetUserDefinedFunctions' => 'Retrieves multiple function definitions from the Data Catalog.
', 'GetWorkflow' => 'Retrieves resource metadata for a workflow.
', 'GetWorkflowRun' => 'Retrieves the metadata for a given workflow run. Job run history is accessible for 90 days for your workflow and job run.
', 'GetWorkflowRunProperties' => 'Retrieves the workflow run properties which were set during the run.
', 'GetWorkflowRuns' => 'Retrieves metadata for all runs of a given workflow.
', 'ImportCatalogToGlue' => 'Imports an existing Amazon Athena Data Catalog to Glue.
', 'ListBlueprints' => 'Lists all the blueprint names in an account.
', 'ListColumnStatisticsTaskRuns' => 'List all task runs for a particular account.
', 'ListCrawlers' => 'Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags
field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.
You may use this API to:
Retrive all the crawls of a specified crawler.
Retrieve all the crawls of a specified crawler within a limited count.
Retrieve all the crawls of a specified crawler in a specific time range.
Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.
Lists all the custom patterns that have been created.
', 'ListDataQualityResults' => 'Returns all data quality execution results for your account.
', 'ListDataQualityRuleRecommendationRuns' => 'Lists the recommendation runs meeting the filter criteria.
', 'ListDataQualityRulesetEvaluationRuns' => 'Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
', 'ListDataQualityRulesets' => 'Returns a paginated list of rulesets for the specified list of Glue tables.
', 'ListDevEndpoints' => 'Retrieves the names of all DevEndpoint
resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags
field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags
field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags
field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.
Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting
status will not be included in the results. Empty results will be returned if there are no registries available.
Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.
', 'ListSchemas' => 'Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.
When the RegistryId
is not provided, all the schemas across registries will be part of the API response.
Retrieve a list of sessions.
', 'ListStatements' => 'Lists statements for the session.
', 'ListTableOptimizerRuns' => 'Lists the history of previous optimizer runs for a specific table.
', 'ListTriggers' => 'Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags
field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
List all the Glue usage profiles.
', 'ListWorkflows' => 'Lists names of workflows created in the account.
', 'PutDataCatalogEncryptionSettings' => 'Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.
', 'PutResourcePolicy' => 'Sets the Data Catalog resource policy for access control.
', 'PutSchemaVersionMetadata' => 'Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls.
', 'PutWorkflowRunProperties' => 'Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.
', 'QuerySchemaVersionMetadata' => 'Queries for the schema version metadata information.
', 'RegisterSchemaVersion' => 'Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion
API with the SchemaVersionId
to check compatibility modes.
If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.
', 'RemoveSchemaVersionMetadata' => 'Removes a key value pair from the schema version metadata for the specified schema version ID.
', 'ResetJobBookmark' => 'Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
', 'ResumeWorkflowRun' => 'Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.
', 'RunStatement' => 'Executes the statement.
', 'SearchTables' => 'Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
', 'StartBlueprintRun' => 'Starts a new run of the specified blueprint.
', 'StartColumnStatisticsTaskRun' => 'Starts a column statistics task run, for a specified table and columns.
', 'StartCrawler' => 'Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.
', 'StartCrawlerSchedule' => 'Changes the schedule state of the specified crawler to SCHEDULED
, unless the crawler is already running or the schedule state is already SCHEDULED
.
Starts a recommendation run that is used to generate rules when you don\'t know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
Recommendation runs are automatically deleted after 90 days.
', 'StartDataQualityRulesetEvaluationRun' => 'Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes results which you can retrieve with the GetDataQualityResult
API.
Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use StartExportLabelsTaskRun
when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the TransformId
whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId
. You can check on the status of your task run by calling the GetMLTaskRun
API.
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun
call and that ultimately results in improving the quality of your machine learning transform.
After the StartMLLabelingSetGenerationTaskRun
finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called \'labeling\' in the machine learning workflows). In the case of the FindMatches
transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to StartImportLabelsTaskRun
. After StartImportLabelsTaskRun
finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.
By default, StartMLLabelingSetGenerationTaskRun
continually learns from and combines all labels that you upload unless you set Replace
to true. If you set Replace
to true, StartImportLabelsTaskRun
deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.
You can check on the status of your task run by calling the GetMLTaskRun
operation.
Starts a job run using a job definition.
', 'StartMLEvaluationTaskRun' => 'Starts a task to estimate the quality of the transform.
When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.
Returns a unique identifier for the run. You can call GetMLTaskRun
to get more information about the stats of the EvaluationTaskRun
.
Starts the active learning workflow for your machine learning transform to improve the transform\'s quality by generating label sets and adding labels.
When the StartMLLabelingSetGenerationTaskRun
finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.
In the case of the FindMatches
transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”
After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun
. After StartImportLabelsTaskRun
finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.
Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.
', 'StartWorkflowRun' => 'Starts a new run of the specified workflow.
', 'StopColumnStatisticsTaskRun' => 'Stops a task run for the specified table.
', 'StopCrawler' => 'If the specified crawler is running, stops the crawl.
', 'StopCrawlerSchedule' => 'Sets the schedule state of the specified crawler to NOT_SCHEDULED
, but does not stop the crawler if it is already running.
Stops the session.
', 'StopTrigger' => 'Stops a specified trigger.
', 'StopWorkflowRun' => 'Stops the execution of the specified workflow run.
', 'TagResource' => 'Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you can tag, see Amazon Web Services Tags in Glue.
', 'UntagResource' => 'Removes tags from a resource.
', 'UpdateBlueprint' => 'Updates a registered blueprint.
', 'UpdateClassifier' => 'Modifies an existing classifier (a GrokClassifier
, an XMLClassifier
, a JsonClassifier
, or a CsvClassifier
, depending on which field is present).
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdatePartition
.
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdateTable
.
Updates a connection definition in the Data Catalog.
', 'UpdateCrawler' => 'Updates a crawler. If a crawler is running, you must stop it using StopCrawler
before updating it.
Updates the schedule of a crawler using a cron
expression.
Updates the specified data quality ruleset.
', 'UpdateDatabase' => 'Updates an existing database definition in a Data Catalog.
', 'UpdateDevEndpoint' => 'Updates a specified development endpoint.
', 'UpdateJob' => 'Updates an existing job definition. The previous job definition is completely overwritten by this information.
', 'UpdateJobFromSourceControl' => 'Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.
This API supports optional parameters which take in the repository information.
', 'UpdateMLTransform' => 'Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.
After calling this operation, you can call the StartMLEvaluationTaskRun
operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).
Updates a partition.
', 'UpdateRegistry' => 'Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.
', 'UpdateSchema' => 'Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility
is provided, the VersionNumber
(a checkpoint) is also required. The API will validate the checkpoint version number for consistency.
If the value for the VersionNumber
(checkpoint) is provided, Compatibility
is optional and this can be used to set/reset a checkpoint for the schema.
This update will happen only if the schema is in the AVAILABLE state.
', 'UpdateSourceControlFromJob' => 'Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.
This API supports optional parameters which take in the repository information.
', 'UpdateTable' => 'Updates a metadata table in the Data Catalog.
', 'UpdateTableOptimizer' => 'Updates the configuration for an existing table optimizer.
', 'UpdateTrigger' => 'Updates a trigger definition.
', 'UpdateUsageProfile' => 'Update an Glue usage profile.
', 'UpdateUserDefinedFunction' => 'Updates an existing function definition in the Data Catalog.
', 'UpdateWorkflow' => 'Updates an existing workflow.
', ], 'shapes' => [ 'AWSManagedClientApplicationReference' => [ 'base' => NULL, 'refs' => [ 'OAuth2ClientApplication$AWSManagedClientApplicationReference' => 'The reference to the SaaS-side client app that is Amazon Web Services managed.
', ], ], 'AccessDeniedException' => [ 'base' => 'Access to a resource was denied.
', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$CustomerId' => 'The Amazon Web Services account ID.
', 'LakeFormationConfiguration$AccountId' => 'Required for cross account crawls. For same account crawls as the target data, this can be left as null.
', ], ], 'Action' => [ 'base' => 'Defines an action to be initiated by a trigger.
', 'refs' => [ 'ActionList$member' => NULL, ], ], 'ActionList' => [ 'base' => NULL, 'refs' => [ 'CreateTriggerRequest$Actions' => 'The actions initiated by this trigger when it fires.
', 'Trigger$Actions' => 'The actions initiated by this trigger.
', 'TriggerUpdate$Actions' => 'The actions initiated by this trigger.
', ], ], 'AdditionalContextMap' => [ 'base' => NULL, 'refs' => [ 'QuerySessionContext$AdditionalContext' => 'An opaque string-string map passed by the query engine.
', ], ], 'AdditionalOptionKeys' => [ 'base' => NULL, 'refs' => [ 'DQAdditionalOptions$key' => NULL, ], ], 'AdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'CatalogDeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'CatalogHudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'JDBCConnectorTarget$AdditionalOptions' => 'Additional connection options for the connector.
', 'S3CatalogDeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'S3CatalogHudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'S3DeltaCatalogTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3DeltaDirectTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3DeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'S3HudiCatalogTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3HudiDirectTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3HudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'SnowflakeNodeData$AdditionalOptions' => 'Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
', 'SparkConnectorSource$AdditionalOptions' => 'Additional connection options for the connector.
', 'SparkConnectorTarget$AdditionalOptions' => 'Additional connection options for the connector.
', ], ], 'AdditionalPlanOptionsMap' => [ 'base' => NULL, 'refs' => [ 'GetPlanRequest$AdditionalPlanOptionsMap' => 'A map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported:
inferSchema
— Specifies whether to set inferSchema
to true or false for the default script generated by an Glue job. For example, to set inferSchema
to true, pass the following key value pair:
--additional-plan-options-map \'{"inferSchema":"true"}\'
Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
', ], ], 'Aggregate' => [ 'base' => 'Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
', 'refs' => [ 'CodeGenConfigurationNode$Aggregate' => 'Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
', ], ], 'AggregateOperation' => [ 'base' => 'Specifies the set of parameters needed to perform aggregation in the aggregate transform.
', 'refs' => [ 'AggregateOperations$member' => NULL, ], ], 'AggregateOperations' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Aggs' => 'Specifies the aggregate functions to be performed on specified fields.
', ], ], 'AllowedValuesStringList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationObject$AllowedValues' => 'A list of allowed values for the parameter.
', ], ], 'AlreadyExistsException' => [ 'base' => 'A resource to be created or added already exists.
', 'refs' => [], ], 'AmazonRedshiftAdvancedOption' => [ 'base' => 'Specifies an optional value when connecting to the Redshift cluster.
', 'refs' => [ 'AmazonRedshiftAdvancedOptions$member' => NULL, ], ], 'AmazonRedshiftAdvancedOptions' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$AdvancedOptions' => 'Optional values when connecting to the Redshift cluster.
', ], ], 'AmazonRedshiftNodeData' => [ 'base' => 'Specifies an Amazon Redshift node.
', 'refs' => [ 'AmazonRedshiftSource$Data' => 'Specifies the data of the Amazon Reshift source node.
', 'AmazonRedshiftTarget$Data' => 'Specifies the data of the Amazon Redshift target node.
', ], ], 'AmazonRedshiftSource' => [ 'base' => 'Specifies an Amazon Redshift source.
', 'refs' => [ 'CodeGenConfigurationNode$AmazonRedshiftSource' => 'Specifies a target that writes to a data source in Amazon Redshift.
', ], ], 'AmazonRedshiftTarget' => [ 'base' => 'Specifies an Amazon Redshift target.
', 'refs' => [ 'CodeGenConfigurationNode$AmazonRedshiftTarget' => 'Specifies a target that writes to a data target in Amazon Redshift.
', ], ], 'ApplyMapping' => [ 'base' => 'Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
', 'refs' => [ 'CodeGenConfigurationNode$ApplyMapping' => 'Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
', ], ], 'ArnString' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredTableMetadataRequest$ParentResourceArn' => 'The resource ARN of the view.
', 'GetUnfilteredTableMetadataRequest$RootResourceArn' => 'The resource ARN of the root view in a chain of nested views.
', 'GetUnfilteredTableMetadataResponse$ResourceArn' => 'The resource ARN of the parent resource extracted from the request.
', 'TableOptimizerConfiguration$roleArn' => 'A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller\'s behalf.
', 'ViewDefinition$Definer' => 'The definer of a view in SQL.
', 'ViewDefinitionInput$Definer' => 'The definer of a view in SQL.
', 'ViewSubObjectsList$member' => NULL, ], ], 'AthenaConnectorSource' => [ 'base' => 'Specifies a connector to an Amazon Athena data source.
', 'refs' => [ 'CodeGenConfigurationNode$AthenaConnectorSource' => 'Specifies a connector to an Amazon Athena data source.
', ], ], 'AttemptCount' => [ 'base' => NULL, 'refs' => [ 'JobRun$Attempt' => 'The number of the attempt to run this job.
', ], ], 'AuditColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'AuditContext$RequestedColumns' => 'The requested columns for audit.
', ], ], 'AuditContext' => [ 'base' => 'A structure containing the Lake Formation audit context.
', 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', 'GetUnfilteredPartitionsMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', 'GetUnfilteredTableMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', ], ], 'AuditContextString' => [ 'base' => NULL, 'refs' => [ 'AuditContext$AdditionalAuditContext' => 'A string containing the additional audit context information.
', ], ], 'AuthTokenString' => [ 'base' => NULL, 'refs' => [ 'UpdateJobFromSourceControlRequest$AuthToken' => 'The value of the authorization token.
', 'UpdateSourceControlFromJobRequest$AuthToken' => 'The value of the authorization token.
', ], ], 'AuthenticationConfiguration' => [ 'base' => 'A structure containing the authentication configuration.
', 'refs' => [ 'Connection$AuthenticationConfiguration' => 'The authentication properties of the connection.
', ], ], 'AuthenticationConfigurationInput' => [ 'base' => 'A structure containing the authentication configuration in the CreateConnection request.
', 'refs' => [ 'ConnectionInput$AuthenticationConfiguration' => 'The authentication properties of the connection. Used for a Salesforce connection.
', ], ], 'AuthenticationType' => [ 'base' => NULL, 'refs' => [ 'AuthenticationConfiguration$AuthenticationType' => 'A structure containing the authentication configuration.
', 'AuthenticationConfigurationInput$AuthenticationType' => 'A structure containing the authentication configuration in the CreateConnection request.
', ], ], 'AuthorizationCode' => [ 'base' => NULL, 'refs' => [ 'AuthorizationCodeProperties$AuthorizationCode' => 'An authorization code to be used in the third leg of the AUTHORIZATION_CODE
grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.
The set of properties required for the the OAuth2 AUTHORIZATION_CODE
grant type workflow.
The set of properties required for the the OAuth2 AUTHORIZATION_CODE
grant type.
A list of errors that can occur when registering partition indexes for an existing table.
These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:
EncryptedPartitionError: The partitions are encrypted.
InvalidPartitionTypeDataError: The partition value doesn\'t match the data type for that partition column.
MissingPartitionValueError: The partitions are encrypted.
UnsupportedPartitionCharacterError: Characters inside the partition value are not supported. For example: U+0000 , U+0001, U+0002.
InternalError: Any error which does not belong to other error codes.
The error code for an error that occurred when registering partition indexes for an existing table.
', ], ], 'BackfillErroredPartitionsList' => [ 'base' => NULL, 'refs' => [ 'BackfillError$Partitions' => 'A list of a limited number of partitions in the response.
', ], ], 'BackfillErrors' => [ 'base' => NULL, 'refs' => [ 'PartitionIndexDescriptor$BackfillErrors' => 'A list of errors that can occur when registering partition indexes for an existing table.
', ], ], 'BasicCatalogTarget' => [ 'base' => 'Specifies a target that uses a Glue Data Catalog table.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogTarget' => 'Specifies a target that uses a Glue Data Catalog table.
', ], ], 'BatchCreatePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchCreatePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionValueList' => [ 'base' => NULL, 'refs' => [ 'BatchDeletePartitionRequest$PartitionsToDelete' => 'A list of PartitionInput
structures that define the partitions to be deleted.
A list of the table to delete.
', ], ], 'BatchDeleteTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTableVersionList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionRequest$VersionIds' => 'A list of the IDs of versions to be deleted. A VersionId
is a string representation of an integer. Each version is incremented by 1.
A list of blueprint names.
', ], ], 'BatchGetBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCustomEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCustomEntityTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDataQualityResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDataQualityResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionValueList' => [ 'base' => NULL, 'refs' => [ 'BatchGetPartitionRequest$PartitionsToGet' => 'A list of partition values identifying the partitions to retrieve.
', 'BatchGetPartitionResponse$UnprocessedKeys' => 'A list of the partition values in the request for which partitions were not returned.
', ], ], 'BatchGetTableOptimizerEntries' => [ 'base' => NULL, 'refs' => [ 'BatchGetTableOptimizerRequest$Entries' => 'A list of BatchGetTableOptimizerEntry
objects specifying the table optimizers to retrieve.
Represents a table optimizer to retrieve in the BatchGetTableOptimizer
operation.
Contains details on one of the errors in the error list returned by the BatchGetTableOptimizer
operation.
A list of errors from the operation.
', ], ], 'BatchGetTableOptimizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTableOptimizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchSize' => [ 'base' => NULL, 'refs' => [ 'EventBatchingCondition$BatchSize' => 'Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
', ], ], 'BatchStopJobRunError' => [ 'base' => 'Records an error that occurred when attempting to stop a specified job run.
', 'refs' => [ 'BatchStopJobRunErrorList$member' => NULL, ], ], 'BatchStopJobRunErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchStopJobRunResponse$Errors' => 'A list of the errors that were encountered in trying to stop JobRuns
, including the JobRunId
for which each error was encountered and details about the error.
A list of the JobRunIds
that should be stopped for that job definition.
Records a successful request to stop a specified JobRun
.
A list of the JobRuns that were successfully submitted for stopping.
', ], ], 'BatchTableOptimizer' => [ 'base' => 'Contains details for one of the table optimizers returned by the BatchGetTableOptimizer
operation.
A list of BatchTableOptimizer
objects.
Contains information about a batch update partition error.
', 'refs' => [ 'BatchUpdatePartitionFailureList$member' => NULL, ], ], 'BatchUpdatePartitionFailureList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePartitionResponse$Errors' => 'The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry
objects.
A structure that contains the values and structure used to update a partition.
', 'refs' => [ 'BatchUpdatePartitionRequestEntryList$member' => NULL, ], ], 'BatchUpdatePartitionRequestEntryList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePartitionRequest$Entries' => 'A list of up to 100 BatchUpdatePartitionRequestEntry
objects to update.
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
', ], ], 'BinaryColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for bit sequence data values.
', 'refs' => [ 'ColumnStatisticsData$BinaryColumnStatisticsData' => 'Binary column statistics data.
', ], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'DecimalNumber$UnscaledValue' => 'The unscaled numeric value.
', ], ], 'Blueprint' => [ 'base' => 'The details of a blueprint.
', 'refs' => [ 'Blueprints$member' => NULL, 'GetBlueprintResponse$Blueprint' => 'Returns a Blueprint
object.
The details of a blueprint.
', 'refs' => [ 'Workflow$BlueprintDetails' => 'This structure indicates the details of the blueprint that this particular workflow is created from.
', ], ], 'BlueprintNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetBlueprintsResponse$MissingBlueprints' => 'Returns a list of BlueprintNames
that were not found.
List of names of blueprints in the account.
', ], ], 'BlueprintParameterSpec' => [ 'base' => NULL, 'refs' => [ 'Blueprint$ParameterSpec' => 'A JSON string that indicates the list of parameter specifications for the blueprint.
', 'LastActiveDefinition$ParameterSpec' => 'A JSON string specifying the parameters for the blueprint.
', ], ], 'BlueprintParameters' => [ 'base' => NULL, 'refs' => [ 'BlueprintRun$Parameters' => 'The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec
.
Specifies the parameters as a BlueprintParameters
object.
The details of a blueprint run.
', 'refs' => [ 'BlueprintRuns$member' => NULL, 'GetBlueprintRunResponse$BlueprintRun' => 'Returns a BlueprintRun
object.
The state of the blueprint run. Possible values are:
Running — The blueprint run is in progress.
Succeeded — The blueprint run completed successfully.
Failed — The blueprint run failed and rollback is complete.
Rolling Back — The blueprint run failed and rollback is in progress.
Returns a list of BlueprintRun
objects.
The status of the blueprint registration.
Creating — The blueprint registration is in progress.
Active — The blueprint has been successfully registered.
Updating — An update to the blueprint registration is in progress.
Failed — The blueprint registration failed.
Returns a list of blueprint as a Blueprints
object.
True
if the migration has completed, or False
otherwise.
True if the value is used as a parameter.
', 'ConnectionInput$ValidateCredentials' => 'A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.
', 'ConnectionPasswordEncryption$ReturnConnectionPasswordEncrypted' => 'When the ReturnConnectionPasswordEncrypted
flag is set to "true", passwords remain encrypted in the responses of GetConnection
and GetConnections
. This encryption takes effect independently from catalog encryption.
True if the crawler is still estimating how long it will take to complete this run.
', 'GetConnectionRequest$HidePassword' => 'Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
', 'GetConnectionsRequest$HidePassword' => 'Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
', 'GetUnfilteredPartitionMetadataResponse$IsRegisteredWithLakeFormation' => 'A Boolean value that indicates whether the partition location is registered with Lake Formation.
', 'GetUnfilteredTableMetadataResponse$IsRegisteredWithLakeFormation' => 'A Boolean value that indicates whether the partition location is registered with Lake Formation.
', 'GetUnfilteredTableMetadataResponse$IsMultiDialectView' => 'Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
', 'GetUnfilteredTableMetadataResponse$IsProtected' => 'A flag that instructs the engine not to push user-provided operations into the logical plan of the view during query planning. However, if set this flag does not guarantee that the engine will comply. Refer to the engine\'s documentation to understand the guarantees provided, if any.
', 'StorageDescriptor$Compressed' => ' True
if the data in the table is compressed, or False
if not.
True
if the table data is stored in subdirectories, or False
if not.
Indicates whether the table has been registered with Lake Formation.
', 'UnfilteredPartition$IsRegisteredWithLakeFormation' => 'A Boolean value indicating that the partition location is registered with Lake Formation.
', 'UpdateTableRequest$Force' => 'A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.
', ], ], 'BooleanColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for Boolean data columns.
', 'refs' => [ 'ColumnStatisticsData$BooleanColumnStatisticsData' => 'Boolean column statistics data.
', ], ], 'BooleanNullable' => [ 'base' => NULL, 'refs' => [ 'GetPartitionsRequest$ExcludeColumnSchema' => 'When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
', 'UpdateTableRequest$SkipArchive' => 'By default, UpdateTable
always creates an archived version of the table before updating it. However, if skipArchive
is set to true, UpdateTable
does not create the archived version.
The action used on Redshift sinks when doing an APPEND.
', 'CreateTriggerRequest$StartOnCreation' => 'Set to true
to start SCHEDULED
and CONDITIONAL
triggers when created. True is not supported for ON_DEMAND
triggers.
True if a list of predecessor runs should be returned.
', 'S3CsvSource$OptimizePerformance' => 'A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
', 'SnowflakeNodeData$Upsert' => 'Used when Action is append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.
Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
', 'UpdateDevEndpointRequest$UpdateEtlLibraries' => ' True
if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False
if otherwise.
A list of values defining the partitions.
', 'BatchUpdatePartitionRequestEntry$PartitionValueList' => 'A list of values defining the partitions.
', 'UpdatePartitionRequest$PartitionValueList' => 'List of partition key values that define the partition to update.
', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'CatalogKafkaSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'CatalogKinesisSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'CatalogSchemaChangePolicy$EnableUpdateCatalog' => 'Whether to use the specified update behavior when the crawler finds a changed schema.
', 'DQResultsPublishingOptions$CloudWatchMetricsEnabled' => 'Enable metrics for your data quality results.
', 'DQResultsPublishingOptions$ResultsPublishingEnabled' => 'Enable publishing for your data quality results.
', 'DirectKafkaSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'DirectKinesisSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'DirectSchemaChangePolicy$EnableUpdateCatalog' => 'Whether to use the specified update behavior when the crawler finds a changed schema.
', 'FilterExpression$Negated' => 'Whether the expression is to be negated.
', 'KafkaStreamingSourceOptions$IncludeHeaders' => 'Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.
Adds a time delay between two consecutive getRecords operations. The default value is "False"
. This option is only configurable for Glue version 2.0 and above.
Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False"
.
If true, then the column is removed.
', 'NullCheckBoxList$IsEmpty' => 'Specifies that an empty string is considered as a null value.
', 'NullCheckBoxList$IsNullString' => 'Specifies that a value spelling out the word \'null\' is considered as a null value.
', 'NullCheckBoxList$IsNegOne' => 'Specifies that an integer value of -1 is considered as a null value.
', 'S3CsvSource$Recurse' => 'If set to true, recursively reads files in all subdirectories under the specified paths.
', 'S3CsvSource$Multiline' => 'A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False
, which allows for more aggressive file-splitting during parsing.
A Boolean value that specifies whether to treat the first line as a header. The default value is False
.
A Boolean value that specifies whether to write the header to output. The default value is True
.
A Boolean value that specifies whether to skip the first data line. The default value is False
.
Sets option to enable a sample path.
', 'S3JsonSource$Recurse' => 'If set to true, recursively reads files in all subdirectories under the specified paths.
', 'S3JsonSource$Multiline' => 'A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False
, which allows for more aggressive file-splitting during parsing.
If set to true, recursively reads files in all subdirectories under the specified paths.
', 'TransformConfigParameter$IsOptional' => 'Specifies whether the parameter is optional or not in the config file of the dynamic transform.
', ], ], 'BoxedDoubleFraction' => [ 'base' => NULL, 'refs' => [ 'PIIDetection$SampleFraction' => 'Indicates the fraction of the data to sample when scanning for PII entities.
', 'PIIDetection$ThresholdFraction' => 'Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
', ], ], 'BoxedLong' => [ 'base' => NULL, 'refs' => [ 'S3DirectSourceAdditionalOptions$BoundedSize' => 'Sets the upper limit for the target size of the dataset in bytes that will be processed.
', 'S3DirectSourceAdditionalOptions$BoundedFiles' => 'Sets the upper limit for the target number of files that will be processed.
', 'S3SourceAdditionalOptions$BoundedSize' => 'Sets the upper limit for the target size of the dataset in bytes that will be processed.
', 'S3SourceAdditionalOptions$BoundedFiles' => 'Sets the upper limit for the target number of files that will be processed.
', ], ], 'BoxedNonNegativeInt' => [ 'base' => NULL, 'refs' => [ 'KafkaStreamingSourceOptions$NumRetries' => 'The number of times to retry before failing to fetch Kafka offsets. The default value is 3
.
The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
', 'KinesisStreamingSourceOptions$NumRetries' => 'The maximum number of retries for Kinesis Data Streams API requests. The default value is 3
.
This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3CsvSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', 'S3JsonSource$MaxBand' => 'This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3JsonSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', 'S3ParquetSource$MaxBand' => 'This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3ParquetSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', ], ], 'BoxedNonNegativeLong' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorOptions$LowerBound' => 'The minimum value of partitionColumn
that is used to decide partition stride.
The maximum value of partitionColumn
that is used to decide partition stride.
The number of partitions. This value, along with lowerBound
(inclusive) and upperBound
(exclusive), form partition strides for generated WHERE
clause expressions that are used to split the partitionColumn
.
The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512
.
The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10
.
The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple GetRecords
API calls may be made within this time. The default value is 1000
.
The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple of MaxRecordPerRead
. The default value is 100000
.
The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000
.
The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000
. This option is only configurable for Glue version 2.0 and above.
The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s
.
The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000
.
The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000
.
The amount of time to spend processing each micro batch.
', 'CatalogKinesisSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', 'DirectKafkaSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', 'DirectKinesisSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', ], ], 'CancelDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelMLTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelMLTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'CatalogDeltaSource' => [ 'base' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogDeltaSource' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
', ], ], 'CatalogEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRest$CatalogEncryptionMode' => 'The encryption-at-rest mode for encrypting Data Catalog data.
', ], ], 'CatalogEntries' => [ 'base' => NULL, 'refs' => [ 'GetMappingRequest$Sinks' => 'A list of target tables.
', 'GetPlanRequest$Sinks' => 'The target tables.
', ], ], 'CatalogEntry' => [ 'base' => 'Specifies a table definition in the Glue Data Catalog.
', 'refs' => [ 'CatalogEntries$member' => NULL, 'GetMappingRequest$Source' => 'Specifies the source table.
', 'GetPlanRequest$Source' => 'The source table.
', ], ], 'CatalogGetterPageSize' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$MaxResults' => 'The maximum number of databases to return in one response.
', 'GetTableVersionsRequest$MaxResults' => 'The maximum number of table versions to return in one response.
', 'GetTablesRequest$MaxResults' => 'The maximum number of tables to return in a single response.
', 'GetUserDefinedFunctionsRequest$MaxResults' => 'The maximum number of functions to return in one response.
', ], ], 'CatalogHudiSource' => [ 'base' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogHudiSource' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog.
', ], ], 'CatalogIdString' => [ 'base' => NULL, 'refs' => [ 'BatchCreatePartitionRequest$CatalogId' => 'The ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services account ID.
', 'BatchDeleteConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeletePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeleteTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeleteTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchGetPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'BatchGetTableOptimizerEntry$catalogId' => 'The Catalog ID of the table.
', 'BatchGetTableOptimizerError$catalogId' => 'The Catalog ID of the table.
', 'BatchTableOptimizer$catalogId' => 'The Catalog ID of the table.
', 'BatchUpdatePartitionRequest$CatalogId' => 'The ID of the catalog in which the partition is to be updated. Currently, this should be the Amazon Web Services account ID.
', 'ColumnStatisticsTaskRun$CatalogID' => 'The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
', 'CreateConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services account ID is used by default.
', 'CreateDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default.
', 'CreatePartitionIndexRequest$CatalogId' => 'The catalog ID where the table resides.
', 'CreatePartitionRequest$CatalogId' => 'The Amazon Web Services account ID of the catalog in which the partition is to be created.
', 'CreateTableOptimizerRequest$CatalogId' => 'The Catalog ID of the table.
', 'CreateTableRequest$CatalogId' => 'The ID of the Data Catalog in which to create the Table
. If none is supplied, the Amazon Web Services account ID is used by default.
The ID of the Data Catalog in which to create the function. If none is provided, the Amazon Web Services account ID is used by default.
', 'Database$CatalogId' => 'The ID of the Data Catalog in which the database resides.
', 'DatabaseIdentifier$CatalogId' => 'The ID of the Data Catalog in which the database resides.
', 'DeleteColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'DeleteColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'DeleteConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeletePartitionIndexRequest$CatalogId' => 'The catalog ID where the table resides.
', 'DeletePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteTableOptimizerRequest$CatalogId' => 'The Catalog ID of the table.
', 'DeleteTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetCatalogImportStatusRequest$CatalogId' => 'The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.
', 'GetColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetConnectionsRequest$CatalogId' => 'The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDataCatalogEncryptionSettingsRequest$CatalogId' => 'The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDatabasesRequest$CatalogId' => 'The ID of the Data Catalog from which to retrieve Databases
. If none is provided, the Amazon Web Services account ID is used by default.
The catalog ID where the table resides.
', 'GetPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetPartitionsRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableOptimizerRequest$CatalogId' => 'The Catalog ID of the table.
', 'GetTableOptimizerResponse$CatalogId' => 'The Catalog ID of the table.
', 'GetTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableVersionsRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTablesRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetUnfilteredPartitionMetadataRequest$CatalogId' => 'The catalog ID where the partition resides.
', 'GetUnfilteredPartitionsMetadataRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default.
', 'GetUnfilteredTableMetadataRequest$CatalogId' => 'The catalog ID where the table resides.
', 'GetUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetUserDefinedFunctionsRequest$CatalogId' => 'The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the Amazon Web Services account ID is used by default.
', 'ImportCatalogToGlueRequest$CatalogId' => 'The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.
', 'ListTableOptimizerRunsRequest$CatalogId' => 'The Catalog ID of the table.
', 'ListTableOptimizerRunsResponse$CatalogId' => 'The Catalog ID of the table.
', 'Partition$CatalogId' => 'The ID of the Data Catalog in which the partition resides.
', 'PutDataCatalogEncryptionSettingsRequest$CatalogId' => 'The ID of the Data Catalog to set the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
', 'SearchTablesRequest$CatalogId' => 'A unique identifier, consisting of account_id
.
The ID of the Data Catalog in which the table resides.
', 'TableIdentifier$CatalogId' => 'The ID of the Data Catalog in which the table resides.
', 'UpdateColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'UpdateColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'UpdateConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdatePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be updated resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateTableOptimizerRequest$CatalogId' => 'The Catalog ID of the table.
', 'UpdateTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be updated is located. If none is provided, the Amazon Web Services account ID is used by default.
', 'UserDefinedFunction$CatalogId' => 'The ID of the Data Catalog in which the function resides.
', ], ], 'CatalogImportStatus' => [ 'base' => 'A structure containing migration status information.
', 'refs' => [ 'GetCatalogImportStatusResponse$ImportStatus' => 'The status of the specified catalog migration.
', ], ], 'CatalogKafkaSource' => [ 'base' => 'Specifies an Apache Kafka data store in the Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogKafkaSource' => 'Specifies an Apache Kafka data store in the Data Catalog.
', ], ], 'CatalogKinesisSource' => [ 'base' => 'Specifies a Kinesis data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogKinesisSource' => 'Specifies a Kinesis data source in the Glue Data Catalog.
', ], ], 'CatalogSchemaChangePolicy' => [ 'base' => 'A policy that specifies update behavior for the crawler.
', 'refs' => [ 'GovernedCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the governed catalog.
', 'S3CatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3DeltaCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3HudiCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', ], ], 'CatalogSource' => [ 'base' => 'Specifies a data store in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogSource' => 'Specifies a data store in the Glue Data Catalog.
', ], ], 'CatalogTablesList' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$Tables' => 'A list of the tables to be synchronized.
', ], ], 'CatalogTarget' => [ 'base' => 'Specifies an Glue Data Catalog target.
', 'refs' => [ 'CatalogTargetList$member' => NULL, ], ], 'CatalogTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$CatalogTargets' => 'Specifies Glue Data Catalog targets.
', ], ], 'CheckSchemaVersionValidityInput' => [ 'base' => NULL, 'refs' => [], ], 'CheckSchemaVersionValidityResponse' => [ 'base' => NULL, 'refs' => [], ], 'Classification' => [ 'base' => NULL, 'refs' => [ 'CreateGrokClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
', 'CreateXMLClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches.
', 'GrokClassifier$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
', 'UpdateGrokClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
', 'UpdateXMLClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches.
', 'XMLClassifier$Classification' => 'An identifier of the data format that the classifier matches.
', ], ], 'Classifier' => [ 'base' => 'Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType
object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok
classifier, an XML
classifier, a JSON
classifier, or a custom CSV
classifier, as specified in one of the fields in the Classifier
object.
The requested classifier.
', ], ], 'ClassifierList' => [ 'base' => NULL, 'refs' => [ 'GetClassifiersResponse$Classifiers' => 'The requested list of classifier objects.
', ], ], 'ClassifierNameList' => [ 'base' => NULL, 'refs' => [ 'Crawler$Classifiers' => 'A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
', 'CreateCrawlerRequest$Classifiers' => 'A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
', 'UpdateCrawlerRequest$Classifiers' => 'A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
', ], ], 'CloudWatchEncryption' => [ 'base' => 'Specifies how Amazon CloudWatch data should be encrypted.
', 'refs' => [ 'EncryptionConfiguration$CloudWatchEncryption' => 'The encryption configuration for Amazon CloudWatch.
', ], ], 'CloudWatchEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEncryption$CloudWatchEncryptionMode' => 'The encryption mode to use for CloudWatch data.
', ], ], 'CodeGenArgName' => [ 'base' => NULL, 'refs' => [ 'CodeGenEdge$TargetParameter' => 'The target of the edge.
', 'CodeGenNodeArg$Name' => 'The name of the argument or property.
', ], ], 'CodeGenArgValue' => [ 'base' => NULL, 'refs' => [ 'CodeGenNodeArg$Value' => 'The value of the argument or property.
', ], ], 'CodeGenConfigurationNode' => [ 'base' => ' CodeGenConfigurationNode
enumerates all valid Node types. One and only one of its member variables can be populated.
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', 'Job$CodeGenConfigurationNodes' => 'The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', 'JobUpdate$CodeGenConfigurationNodes' => 'The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', ], ], 'CodeGenEdge' => [ 'base' => 'Represents a directional edge in a directed acyclic graph (DAG).
', 'refs' => [ 'DagEdges$member' => NULL, ], ], 'CodeGenIdentifier' => [ 'base' => NULL, 'refs' => [ 'CodeGenEdge$Source' => 'The ID of the node at which the edge starts.
', 'CodeGenEdge$Target' => 'The ID of the node at which the edge ends.
', 'CodeGenNode$Id' => 'A node identifier that is unique within the node\'s graph.
', ], ], 'CodeGenNode' => [ 'base' => 'Represents a node in a directed acyclic graph (DAG)
', 'refs' => [ 'DagNodes$member' => NULL, ], ], 'CodeGenNodeArg' => [ 'base' => 'An argument or property of a node.
', 'refs' => [ 'CodeGenNodeArgs$member' => NULL, ], ], 'CodeGenNodeArgs' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$Args' => 'Properties of the node, in the form of name-value pairs.
', 'Location$Jdbc' => 'A JDBC location.
', 'Location$S3' => 'An Amazon Simple Storage Service (Amazon S3) location.
', 'Location$DynamoDB' => 'An Amazon DynamoDB table location.
', ], ], 'CodeGenNodeType' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$NodeType' => 'The type of node that this is.
', ], ], 'Column' => [ 'base' => 'A column in a Table
.
Encapsulates a column name that failed and the reason for failure.
', 'refs' => [ 'ColumnErrors$member' => NULL, ], ], 'ColumnErrors' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionResponse$Errors' => 'Error occurred during retrieving column statistics data.
', 'GetColumnStatisticsForTableResponse$Errors' => 'List of ColumnStatistics that failed to be retrieved.
', ], ], 'ColumnImportance' => [ 'base' => 'A structure containing the column name and column importance score for a column.
Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
', 'refs' => [ 'ColumnImportanceList$member' => NULL, ], ], 'ColumnImportanceList' => [ 'base' => NULL, 'refs' => [ 'FindMatchesMetrics$ColumnImportances' => 'A list of ColumnImportance
structures containing column importance metrics, sorted in order of descending importance.
A list of the Columns
in the table.
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys
, you must at least set the value of partitionKeys
to an empty list. For example:
"PartitionKeys": []
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys
, you must at least set the value of partitionKeys
to an empty list. For example:
"PartitionKeys": []
A list of the column names. If none is supplied, all column names for the table will be used by default.
', 'StartColumnStatisticsTaskRunRequest$ColumnNameList' => 'A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
', ], ], 'ColumnNameString' => [ 'base' => NULL, 'refs' => [ 'AuditColumnNamesList$member' => NULL, 'FindMatchesParameters$PrimaryKeyColumnName' => 'The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
', 'SchemaColumn$Name' => 'The name of the column.
', ], ], 'ColumnRowFilter' => [ 'base' => 'A filter that uses both column-level and row-level filtering.
', 'refs' => [ 'ColumnRowFilterList$member' => NULL, ], ], 'ColumnRowFilterList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredTableMetadataResponse$CellFilters' => 'A list of column row filters.
', ], ], 'ColumnStatistics' => [ 'base' => 'Represents the generated column-level statistics for a table or partition.
', 'refs' => [ 'ColumnStatisticsError$ColumnStatistics' => 'The ColumnStatistics
of the column.
Contains the individual types of column statistics data. Only one data object should be set and indicated by the Type
attribute.
A ColumnStatisticData
object that contains the statistics data values.
Encapsulates a ColumnStatistics
object that failed and the reason for failure.
Error occurred during updating column statistics data.
', 'UpdateColumnStatisticsForTableResponse$Errors' => 'List of ColumnStatisticsErrors.
', ], ], 'ColumnStatisticsList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionResponse$ColumnStatisticsList' => 'List of ColumnStatistics that failed to be retrieved.
', 'GetColumnStatisticsForTableResponse$ColumnStatisticsList' => 'List of ColumnStatistics.
', ], ], 'ColumnStatisticsState' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$Status' => 'The status of the task run.
', ], ], 'ColumnStatisticsTaskNotRunningException' => [ 'base' => 'An exception thrown when you try to stop a task run when there is no task running.
', 'refs' => [], ], 'ColumnStatisticsTaskRun' => [ 'base' => 'The object that shows the details of the column stats run.
', 'refs' => [ 'ColumnStatisticsTaskRunsList$member' => NULL, 'GetColumnStatisticsTaskRunResponse$ColumnStatisticsTaskRun' => 'A ColumnStatisticsTaskRun
object representing the details of the column stats run.
A list of column statistics task run IDs.
', ], ], 'ColumnStatisticsTaskRunningException' => [ 'base' => 'An exception thrown when you try to start another job while running a column stats generation job.
', 'refs' => [], ], 'ColumnStatisticsTaskRunsList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsTaskRunsResponse$ColumnStatisticsTaskRuns' => 'A list of column statistics task runs.
', ], ], 'ColumnStatisticsTaskStoppingException' => [ 'base' => 'An exception thrown when you try to stop a task run.
', 'refs' => [], ], 'ColumnStatisticsType' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsData$Type' => 'The type of column statistics data.
', ], ], 'ColumnTypeString' => [ 'base' => NULL, 'refs' => [ 'Column$Type' => 'The data type of the Column
.
The hive type for this column in the Glue Studio schema.
', 'KeySchemaElement$Type' => 'The type of a partition key.
', 'SchemaColumn$DataType' => 'The type of data in the column.
', ], ], 'ColumnValueStringList' => [ 'base' => NULL, 'refs' => [ 'SkewedInfo$SkewedColumnValues' => 'A list of values that appear so frequently as to be considered skewed.
', ], ], 'ColumnValuesString' => [ 'base' => NULL, 'refs' => [ 'ColumnValueStringList$member' => NULL, 'LocationMap$key' => NULL, 'LocationMap$value' => NULL, ], ], 'CommentString' => [ 'base' => NULL, 'refs' => [ 'Column$Comment' => 'A free-form text comment.
', ], ], 'CommitIdString' => [ 'base' => NULL, 'refs' => [ 'UpdateJobFromSourceControlRequest$CommitId' => 'A commit ID for a commit in the remote repository.
', 'UpdateSourceControlFromJobRequest$CommitId' => 'A commit ID for a commit in the remote repository.
', ], ], 'Comparator' => [ 'base' => NULL, 'refs' => [ 'PropertyPredicate$Comparator' => 'The comparator used to compare this property to others.
', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaInput$Compatibility' => 'The compatibility mode of the schema. The possible values are:
NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can\'t be read by readers using the previous version.
BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
The schema compatibility mode.
', 'GetSchemaResponse$Compatibility' => 'The compatibility mode of the schema.
', 'UpdateSchemaInput$Compatibility' => 'The new compatibility setting for the schema.
', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'S3CsvSource$CompressionType' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Two processes are trying to modify a resource simultaneously.
', 'refs' => [], ], 'ConcurrentRunsExceededException' => [ 'base' => 'Too many jobs are being run concurrently.
', 'refs' => [], ], 'Condition' => [ 'base' => 'Defines a condition under which a trigger fires.
', 'refs' => [ 'ConditionList$member' => NULL, ], ], 'ConditionCheckFailureException' => [ 'base' => 'A specified condition was not satisfied.
', 'refs' => [], ], 'ConditionList' => [ 'base' => NULL, 'refs' => [ 'Predicate$Conditions' => 'A list of the conditions that determine when the trigger will fire.
', ], ], 'ConfigValueString' => [ 'base' => NULL, 'refs' => [ 'AllowedValuesStringList$member' => NULL, 'ConfigurationObject$DefaultValue' => 'A default value for the parameter.
', 'ConfigurationObject$MinValue' => 'A minimum allowed value for the parameter.
', 'ConfigurationObject$MaxValue' => 'A maximum allowed value for the parameter.
', ], ], 'ConfigurationMap' => [ 'base' => NULL, 'refs' => [ 'ProfileConfiguration$SessionConfiguration' => 'A key-value map of configuration parameters for Glue sessions.
', 'ProfileConfiguration$JobConfiguration' => 'A key-value map of configuration parameters for Glue jobs.
', ], ], 'ConfigurationObject' => [ 'base' => 'Specifies the values that an admin sets for each job or session parameter configured in a Glue usage profile.
', 'refs' => [ 'ConfigurationMap$value' => NULL, ], ], 'ConflictException' => [ 'base' => 'The CreatePartitions
API was called on a table that has indexes enabled.
The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
', 'refs' => [ 'FindMatchesMetrics$ConfusionMatrix' => 'The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
', ], ], 'Connection' => [ 'base' => 'Defines a connection to a data source.
', 'refs' => [ 'ConnectionList$member' => NULL, 'GetConnectionResponse$Connection' => 'The requested connection definition.
', ], ], 'ConnectionInput' => [ 'base' => 'A structure that is used to specify a connection to create or update.
', 'refs' => [ 'CreateConnectionRequest$ConnectionInput' => 'A ConnectionInput
object defining the connection to create.
A ConnectionInput
object that redefines the connection in question.
A list of requested connection definitions.
', ], ], 'ConnectionName' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$ConnectionName' => 'The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog
connection type paired with a NETWORK
Connection type.
The name of the connection to use to connect to the Delta table target.
', 'HudiTarget$ConnectionName' => 'The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
', 'IcebergTarget$ConnectionName' => 'The name of the connection to use to connect to the Iceberg target.
', 'JdbcTarget$ConnectionName' => 'The name of the connection to use to connect to the JDBC target.
', 'MongoDBTarget$ConnectionName' => 'The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
', 'S3Target$ConnectionName' => 'The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
', ], ], 'ConnectionPasswordEncryption' => [ 'base' => 'The data structure used by the Data Catalog to encrypt the password as part of CreateConnection
or UpdateConnection
and store it in the ENCRYPTED_PASSWORD
field in the connection properties. You can enable catalog encryption or only password encryption.
When a CreationConnection
request arrives containing a password, the Data Catalog first encrypts the password using your KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.
This encryption requires that you set KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.
', 'refs' => [ 'DataCatalogEncryptionSettings$ConnectionPasswordEncryption' => 'When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection
or UpdateConnection
and store it in the ENCRYPTED_PASSWORD
field in the connection properties. You can enable catalog encryption or only password encryption.
These key-value pairs define parameters for the connection:
HOST
- The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT
- The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME
- The name under which to log in to the database. The value string for USER_NAME
is "USERNAME
".
PASSWORD
- A password, if one is used, for the user name.
ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
JDBC_ENGINE
- The name of the JDBC engine to use.
JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
CONFIG_FILES
- (Reserved for future use.)
INSTANCE_ID
- The instance ID to use.
JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer\'s root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
SECRET_ID
- The secret ID used for the secret manager of credentials.
CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection.
CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".
KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".
KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
, "AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with sasl.kerberos.service.name
in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
These key-value pairs define parameters for the connection.
', ], ], 'ConnectionPropertyKey' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$key' => NULL, ], ], 'ConnectionStatus' => [ 'base' => NULL, 'refs' => [ 'Connection$Status' => 'The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.
', ], ], 'ConnectionType' => [ 'base' => NULL, 'refs' => [ 'Connection$ConnectionType' => 'The type of the connection. Currently, SFTP is not supported.
', 'ConnectionInput$ConnectionType' => 'The type of the connection. Currently, these types are supported:
JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).
JDBC
Connections use the following ConnectionParameters.
Required: All of (HOST
, PORT
, JDBC_ENGINE
) or JDBC_CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
Optional: JDBC_ENFORCE_SSL
, CUSTOM_JDBC_CERT
, CUSTOM_JDBC_CERT_STRING
, SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
KAFKA
- Designates a connection to an Apache Kafka streaming platform.
KAFKA
Connections use the following ConnectionParameters.
Required: KAFKA_BOOTSTRAP_SERVERS
.
Optional: KAFKA_SSL_ENABLED
, KAFKA_CUSTOM_CERT
, KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL with KAFKA
.
Optional: KAFKA_CLIENT_KEYSTORE
, KAFKA_CLIENT_KEYSTORE_PASSWORD
, KAFKA_CLIENT_KEY_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL in KAFKA
.
Optional: KAFKA_SASL_MECHANISM
. Can be specified as SCRAM-SHA-512
, GSSAPI
, or AWS_MSK_IAM
.
Optional: KAFKA_SASL_SCRAM_USERNAME
, KAFKA_SASL_SCRAM_PASSWORD
, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA
.
Optional: KAFKA_SASL_GSSAPI_KEYTAB
, KAFKA_SASL_GSSAPI_KRB5_CONF
, KAFKA_SASL_GSSAPI_SERVICE
, KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication with KAFKA
.
MONGODB
- Designates a connection to a MongoDB document database.
MONGODB
Connections use the following ConnectionParameters.
Required: CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
SALESFORCE
- Designates a connection to Salesforce using OAuth authencation.
Requires the AuthenticationConfiguration
member to be configured.
NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
MARKETPLACE
Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE
, CONNECTOR_URL
, CONNECTOR_CLASS_NAME
, CONNECTION_URL
.
Required for JDBC
CONNECTOR_TYPE
connections: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
SFTP
is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
', 'GetConnectionsFilter$ConnectionType' => 'The type of connections to return. Currently, SFTP is not supported.
', ], ], 'ConnectionsList' => [ 'base' => 'Specifies the connections used by a job.
', 'refs' => [ 'CreateJobRequest$Connections' => 'The connections used for this job.
', 'CreateSessionRequest$Connections' => 'The number of connections to use for the session.
', 'Job$Connections' => 'The connections used for this job.
', 'JobUpdate$Connections' => 'The connections used for this job.
', 'Session$Connections' => 'The number of connections used for the session.
', ], ], 'ConnectorDataSource' => [ 'base' => 'Specifies a source generated with standard connection options.
', 'refs' => [ 'CodeGenConfigurationNode$ConnectorDataSource' => 'Specifies a source generated with standard connection options.
', ], ], 'ConnectorDataTarget' => [ 'base' => 'Specifies a target generated with standard connection options.
', 'refs' => [ 'CodeGenConfigurationNode$ConnectorDataTarget' => 'Specifies a target generated with standard connection options.
', ], ], 'ConnectorOptions' => [ 'base' => NULL, 'refs' => [ 'ConnectorDataSource$Data' => 'A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
', 'ConnectorDataTarget$Data' => 'A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
', ], ], 'ContextKey' => [ 'base' => NULL, 'refs' => [ 'AdditionalContextMap$key' => NULL, ], ], 'ContextValue' => [ 'base' => NULL, 'refs' => [ 'AdditionalContextMap$value' => NULL, ], ], 'ContextWords' => [ 'base' => NULL, 'refs' => [ 'CreateCustomEntityTypeRequest$ContextWords' => 'A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
', 'CustomEntityType$ContextWords' => 'A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
', 'GetCustomEntityTypeResponse$ContextWords' => 'A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
', ], ], 'Crawl' => [ 'base' => 'The details of a crawl in the workflow.
', 'refs' => [ 'CrawlList$member' => NULL, ], ], 'CrawlId' => [ 'base' => NULL, 'refs' => [ 'CrawlerHistory$CrawlId' => 'A UUID identifier for each crawl.
', ], ], 'CrawlList' => [ 'base' => NULL, 'refs' => [ 'CrawlerNodeDetails$Crawls' => 'A list of crawls represented by the crawl node.
', ], ], 'CrawlState' => [ 'base' => NULL, 'refs' => [ 'Condition$CrawlState' => 'The state of the crawler to which this condition applies.
', 'Crawl$State' => 'The state of the crawler.
', ], ], 'Crawler' => [ 'base' => 'Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
', 'refs' => [ 'CrawlerList$member' => NULL, 'GetCrawlerResponse$Crawler' => 'The metadata for the specified crawler.
', ], ], 'CrawlerConfiguration' => [ 'base' => NULL, 'refs' => [ 'Crawler$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', 'CreateCrawlerRequest$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', 'UpdateCrawlerRequest$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', ], ], 'CrawlerHistory' => [ 'base' => 'Contains the information for a run of a crawler.
', 'refs' => [ 'CrawlerHistoryList$member' => NULL, ], ], 'CrawlerHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListCrawlsResponse$Crawls' => 'A list of CrawlerHistory
objects representing the crawl runs that meet your criteria.
The state of the crawl.
', ], ], 'CrawlerLineageSettings' => [ 'base' => NULL, 'refs' => [ 'LineageConfiguration$CrawlerLineageSettings' => 'Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
A list of crawler definitions.
', 'GetCrawlersResponse$Crawlers' => 'A list of crawler metadata.
', ], ], 'CrawlerMetrics' => [ 'base' => 'Metrics for a specified crawler.
', 'refs' => [ 'CrawlerMetricsList$member' => NULL, ], ], 'CrawlerMetricsList' => [ 'base' => NULL, 'refs' => [ 'GetCrawlerMetricsResponse$CrawlerMetricsList' => 'A list of metrics for the specified crawler.
', ], ], 'CrawlerNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetCrawlersRequest$CrawlerNames' => 'A list of crawler names, which might be the names returned from the ListCrawlers
operation.
A list of names of crawlers that were not found.
', 'GetCrawlerMetricsRequest$CrawlerNameList' => 'A list of the names of crawlers about which to retrieve metrics.
', 'ListCrawlersResponse$CrawlerNames' => 'The names of all crawlers in the account, or the crawlers with the specified tags.
', ], ], 'CrawlerNodeDetails' => [ 'base' => 'The details of a Crawler node present in the workflow.
', 'refs' => [ 'Node$CrawlerDetails' => 'Details of the crawler when the node represents a crawler.
', ], ], 'CrawlerNotRunningException' => [ 'base' => 'The specified crawler is not running.
', 'refs' => [], ], 'CrawlerRunningException' => [ 'base' => 'The operation cannot be performed because the crawler is already running.
', 'refs' => [], ], 'CrawlerSecurityConfiguration' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$SecurityConfiguration' => 'Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
', 'Crawler$CrawlerSecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used by this crawler.
The name of the SecurityConfiguration
structure to be used by this crawler.
The name of the SecurityConfiguration
structure to be used by this crawler.
Indicates whether the crawler is running, or whether a run is pending.
', ], ], 'CrawlerStoppingException' => [ 'base' => 'The specified crawler is stopping.
', 'refs' => [], ], 'CrawlerTargets' => [ 'base' => 'Specifies data stores to crawl.
', 'refs' => [ 'Crawler$Targets' => 'A collection of targets to crawl.
', 'CreateCrawlerRequest$Targets' => 'A list of collection of targets to crawl.
', 'UpdateCrawlerRequest$Targets' => 'A list of targets to crawl.
', ], ], 'CrawlsFilter' => [ 'base' => 'A list of fields, comparators and value that you can use to filter the crawler runs for a specified crawler.
', 'refs' => [ 'CrawlsFilterList$member' => NULL, ], ], 'CrawlsFilterList' => [ 'base' => NULL, 'refs' => [ 'ListCrawlsRequest$Filters' => 'Filters the crawls by the criteria you specify in a list of CrawlsFilter
objects.
Specifies a custom CSV classifier for CreateClassifier
to create.
A CsvClassifier
object specifying the classifier to create.
Specifies a grok
classifier for CreateClassifier
to create.
A GrokClassifier
object specifying the classifier to create.
Specifies a JSON classifier for CreateClassifier
to create.
A JsonClassifier
object specifying the classifier to create.
Request to create a new session.
', 'refs' => [], ], 'CreateSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableOptimizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableOptimizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUsageProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUsageProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateXMLClassifierRequest' => [ 'base' => 'Specifies an XML classifier for CreateClassifier
to create.
An XMLClassifier
object specifying the classifier to create.
The date and time the registry was created.
', 'GetSchemaByDefinitionResponse$CreatedTime' => 'The date and time the schema was created.
', 'GetSchemaResponse$CreatedTime' => 'The date and time the schema was created.
', 'GetSchemaVersionResponse$CreatedTime' => 'The date and time the schema version was created.
', 'MetadataInfo$CreatedTime' => 'The time at which the entry was created.
', 'OtherMetadataValueListItem$CreatedTime' => 'The time at which the entry was created.
', 'RegistryListItem$CreatedTime' => 'The data the registry was created.
', 'SchemaListItem$CreatedTime' => 'The date and time that a schema was created.
', 'SchemaVersionListItem$CreatedTime' => 'The date and time the schema version was created.
', ], ], 'CronExpression' => [ 'base' => NULL, 'refs' => [ 'CreateCrawlerRequest$Schedule' => 'A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
The updated cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
A classifier for custom CSV
content.
A classifier for comma-separated values (CSV).
', ], ], 'CsvColumnDelimiter' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', 'CsvClassifier$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', 'UpdateCsvClassifierRequest$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', ], ], 'CsvHeader' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Header' => 'A list of strings representing column names.
', 'CsvClassifier$Header' => 'A list of strings representing column names.
', 'UpdateCsvClassifierRequest$Header' => 'A list of strings representing column names.
', ], ], 'CsvHeaderOption' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', 'CsvClassifier$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', 'UpdateCsvClassifierRequest$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', ], ], 'CsvQuoteSymbol' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.
', 'CsvClassifier$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
', 'UpdateCsvClassifierRequest$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
', ], ], 'CsvSerdeOption' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Serde' => 'Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe
, LazySimpleSerDe
, and None
. You can specify the None
value when you want the crawler to do the detection.
Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe
, LazySimpleSerDe
, and None
. You can specify the None
value when you want the crawler to do the detection.
Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe
, LazySimpleSerDe
, and None
. You can specify the None
value when you want the crawler to do the detection.
Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
', 'refs' => [ 'CodeGenConfigurationNode$CustomCode' => 'Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
', ], ], 'CustomDatatypes' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$CustomDatatypes' => 'Creates a list of supported custom datatypes.
', 'CsvClassifier$CustomDatatypes' => 'A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
', 'UpdateCsvClassifierRequest$CustomDatatypes' => 'Specifies a list of supported custom datatypes.
', ], ], 'CustomEntityType' => [ 'base' => 'An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.
', 'refs' => [ 'CustomEntityTypes$member' => NULL, ], ], 'CustomEntityTypeNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomEntityTypesRequest$Names' => 'A list of names of the custom patterns that you want to retrieve.
', 'BatchGetCustomEntityTypesResponse$CustomEntityTypesNotFound' => 'A list of the names of custom patterns that were not found.
', ], ], 'CustomEntityTypes' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomEntityTypesResponse$CustomEntityTypes' => 'A list of CustomEntityType
objects representing the custom patterns that have been created.
A list of CustomEntityType
objects representing custom patterns.
Optional custom grok patterns used by this classifier.
', 'GrokClassifier$CustomPatterns' => 'Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
', 'UpdateGrokClassifierRequest$CustomPatterns' => 'Optional custom grok patterns used by this classifier.
', ], ], 'DQAdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQualityMultiFrame$AdditionalOptions' => 'Options to configure runtime behavior of the transform.
', ], ], 'DQCompositeRuleEvaluationMethod' => [ 'base' => NULL, 'refs' => [ 'DataQualityEvaluationRunAdditionalRunOptions$CompositeRuleEvaluationMethod' => 'Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
', ], ], 'DQDLAliases' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQualityMultiFrame$AdditionalDataSources' => 'The aliases of all data sources except primary.
', ], ], 'DQDLString' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQuality$Ruleset' => 'The ruleset for your data quality evaluation.
', 'EvaluateDataQualityMultiFrame$Ruleset' => 'The ruleset for your data quality evaluation.
', ], ], 'DQResultsPublishingOptions' => [ 'base' => 'Options to configure how your data quality evaluation results are published.
', 'refs' => [ 'EvaluateDataQuality$PublishingOptions' => 'Options to configure how your results are published.
', 'EvaluateDataQualityMultiFrame$PublishingOptions' => 'Options to configure how your results are published.
', ], ], 'DQStopJobOnFailureOptions' => [ 'base' => 'Options to configure how your job will stop if your data quality evaluation fails.
', 'refs' => [ 'EvaluateDataQuality$StopJobOnFailureOptions' => 'Options to configure how your job will stop if your data quality evaluation fails.
', 'EvaluateDataQualityMultiFrame$StopJobOnFailureOptions' => 'Options to configure how your job will stop if your data quality evaluation fails.
', ], ], 'DQStopJobOnFailureTiming' => [ 'base' => NULL, 'refs' => [ 'DQStopJobOnFailureOptions$StopJobOnFailureTiming' => 'When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
', ], ], 'DQTransformOutput' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQuality$Output' => 'The output of your data quality evaluation.
', ], ], 'DagEdges' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$DagEdges' => 'A list of the edges in the DAG.
', 'GetDataflowGraphResponse$DagEdges' => 'A list of the edges in the resulting DAG.
', ], ], 'DagNodes' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$DagNodes' => 'A list of the nodes in the DAG.
', 'GetDataflowGraphResponse$DagNodes' => 'A list of the nodes in the resulting DAG.
', ], ], 'DataCatalogEncryptionSettings' => [ 'base' => 'Contains configuration information for maintaining Data Catalog security.
', 'refs' => [ 'GetDataCatalogEncryptionSettingsResponse$DataCatalogEncryptionSettings' => 'The requested security configuration.
', 'PutDataCatalogEncryptionSettingsRequest$DataCatalogEncryptionSettings' => 'The security configuration to set.
', ], ], 'DataFormat' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityInput$DataFormat' => 'The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The Lake Formation principal.
', 'refs' => [ 'PrincipalPermissions$Principal' => 'The principal who is granted permissions.
', ], ], 'DataLakePrincipalString' => [ 'base' => NULL, 'refs' => [ 'DataLakePrincipal$DataLakePrincipalIdentifier' => 'An identifier for the Lake Formation principal.
', ], ], 'DataQualityAnalyzerResult' => [ 'base' => 'Describes the result of the evaluation of a data quality analyzer.
', 'refs' => [ 'DataQualityAnalyzerResults$member' => NULL, ], ], 'DataQualityAnalyzerResults' => [ 'base' => NULL, 'refs' => [ 'DataQualityResult$AnalyzerResults' => 'A list of DataQualityAnalyzerResult
objects representing the results for each analyzer.
A list of DataQualityAnalyzerResult
objects representing the results for each analyzer.
Additional run options you can specify for an evaluation run.
', 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$AdditionalRunOptions' => 'Additional run options you can specify for an evaluation run.
', 'StartDataQualityRulesetEvaluationRunRequest$AdditionalRunOptions' => 'Additional run options you can specify for an evaluation run.
', ], ], 'DataQualityMetricValues' => [ 'base' => 'Describes the data quality metric value according to the analysis of historical data.
', 'refs' => [ 'MetricBasedObservation$MetricValues' => 'An object of type DataQualityMetricValues
representing the analysis of the data quality metric value.
Describes the observation generated after evaluating the rules and analyzers.
', 'refs' => [ 'DataQualityObservations$member' => NULL, ], ], 'DataQualityObservationDescription' => [ 'base' => NULL, 'refs' => [ 'DataQualityObservation$Description' => 'A description of the data quality observation.
', ], ], 'DataQualityObservations' => [ 'base' => NULL, 'refs' => [ 'DataQualityResult$Observations' => 'A list of DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.
A list of DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.
Describes a data quality result.
', 'refs' => [ 'DataQualityResultsList$member' => NULL, ], ], 'DataQualityResultDescription' => [ 'base' => 'Describes a data quality result.
', 'refs' => [ 'DataQualityResultDescriptionList$member' => NULL, ], ], 'DataQualityResultDescriptionList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityResultsResponse$Results' => 'A list of DataQualityResultDescription
objects.
Criteria used to return data quality results.
', 'refs' => [ 'ListDataQualityResultsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityResultIdList' => [ 'base' => NULL, 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$ResultIds' => 'A list of result IDs for the data quality results for the run.
', ], ], 'DataQualityResultIds' => [ 'base' => NULL, 'refs' => [ 'BatchGetDataQualityResultRequest$ResultIds' => 'A list of unique result IDs for the data quality results.
', 'BatchGetDataQualityResultResponse$ResultsNotFound' => 'A list of result IDs for which results were not found.
', ], ], 'DataQualityResultsList' => [ 'base' => NULL, 'refs' => [ 'BatchGetDataQualityResultResponse$Results' => 'A list of DataQualityResult
objects representing the data quality results.
Describes the result of a data quality rule recommendation run.
', 'refs' => [ 'DataQualityRuleRecommendationRunList$member' => NULL, ], ], 'DataQualityRuleRecommendationRunFilter' => [ 'base' => 'A filter for listing data quality recommendation runs.
', 'refs' => [ 'ListDataQualityRuleRecommendationRunsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRuleRecommendationRunList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRuleRecommendationRunsResponse$Runs' => 'A list of DataQualityRuleRecommendationRunDescription
objects.
Describes the result of the evaluation of a data quality rule.
', 'refs' => [ 'DataQualityRuleResults$member' => NULL, ], ], 'DataQualityRuleResultDescription' => [ 'base' => NULL, 'refs' => [ 'DataQualityAnalyzerResult$Description' => 'A description of the data quality analyzer.
', 'DataQualityAnalyzerResult$EvaluationMessage' => 'An evaluation message.
', 'DataQualityRuleResult$Description' => 'A description of the data quality rule.
', 'DataQualityRuleResult$EvaluationMessage' => 'An evaluation message.
', ], ], 'DataQualityRuleResultStatus' => [ 'base' => NULL, 'refs' => [ 'DataQualityRuleResult$Result' => 'A pass or fail status for the rule.
', ], ], 'DataQualityRuleResults' => [ 'base' => NULL, 'refs' => [ 'DataQualityResult$RuleResults' => 'A list of DataQualityRuleResult
objects representing the results for each rule.
A list of DataQualityRuleResult
objects representing the results for each rule.
Describes the result of a data quality ruleset evaluation run.
', 'refs' => [ 'DataQualityRulesetEvaluationRunList$member' => NULL, ], ], 'DataQualityRulesetEvaluationRunFilter' => [ 'base' => 'The filter criteria.
', 'refs' => [ 'ListDataQualityRulesetEvaluationRunsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRulesetEvaluationRunList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRulesetEvaluationRunsResponse$Runs' => 'A list of DataQualityRulesetEvaluationRunDescription
objects representing data quality ruleset runs.
The criteria used to filter data quality rulesets.
', 'refs' => [ 'ListDataQualityRulesetsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRulesetList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRulesetsResponse$Rulesets' => 'A paginated list of rulesets for the specified list of Glue tables.
', ], ], 'DataQualityRulesetListDetails' => [ 'base' => 'Describes a data quality ruleset returned by GetDataQualityRuleset
.
A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'GetDataQualityRuleRecommendationRunResponse$RecommendedRuleset' => 'When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
', 'GetDataQualityRulesetResponse$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'UpdateDataQualityRulesetRequest$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'UpdateDataQualityRulesetResponse$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', ], ], 'DataQualityTargetTable' => [ 'base' => 'An object representing an Glue table.
', 'refs' => [ 'CreateDataQualityRulesetRequest$TargetTable' => 'A target table associated with the data quality ruleset.
', 'DataQualityRulesetFilterCriteria$TargetTable' => 'The name and database name of the target table.
', 'DataQualityRulesetListDetails$TargetTable' => 'An object representing an Glue table.
', 'GetDataQualityRulesetResponse$TargetTable' => 'The name and database name of the target table.
', ], ], 'DataSource' => [ 'base' => 'A data source (an Glue table) for which you want data quality results.
', 'refs' => [ 'DataQualityResult$DataSource' => 'The table associated with the data quality result, if any.
', 'DataQualityResultDescription$DataSource' => 'The table name associated with the data quality result.
', 'DataQualityResultFilterCriteria$DataSource' => 'Filter results by the specified data source. For example, retrieving all results for an Glue table.
', 'DataQualityRuleRecommendationRunDescription$DataSource' => 'The data source (Glue table) associated with the recommendation run.
', 'DataQualityRuleRecommendationRunFilter$DataSource' => 'Filter based on a specified data source (Glue table).
', 'DataQualityRulesetEvaluationRunDescription$DataSource' => 'The data source (an Glue table) associated with the run.
', 'DataQualityRulesetEvaluationRunFilter$DataSource' => 'Filter based on a data source (an Glue table) associated with the run.
', 'DataSourceMap$value' => NULL, 'GetDataQualityResultResponse$DataSource' => 'The table associated with the data quality result, if any.
', 'GetDataQualityRuleRecommendationRunResponse$DataSource' => 'The data source (an Glue table) associated with this run.
', 'GetDataQualityRulesetEvaluationRunResponse$DataSource' => 'The data source (an Glue table) associated with this evaluation run.
', 'StartDataQualityRuleRecommendationRunRequest$DataSource' => 'The data source (Glue table) associated with this run.
', 'StartDataQualityRulesetEvaluationRunRequest$DataSource' => 'The data source (Glue table) associated with this run.
', ], ], 'DataSourceMap' => [ 'base' => NULL, 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$AdditionalDataSources' => 'A map of reference strings to additional data sources you can specify for an evaluation run.
', 'StartDataQualityRulesetEvaluationRunRequest$AdditionalDataSources' => 'A map of reference strings to additional data sources you can specify for an evaluation run.
', ], ], 'Database' => [ 'base' => 'The Database
object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
The definition of the specified database in the Data Catalog.
', ], ], 'DatabaseIdentifier' => [ 'base' => 'A structure that describes a target database for resource linking.
', 'refs' => [ 'Database$TargetDatabase' => 'A DatabaseIdentifier
structure that describes a target database for resource linking.
A DatabaseIdentifier
structure that describes a target database for resource linking.
The structure used to create or update a database.
', 'refs' => [ 'CreateDatabaseRequest$DatabaseInput' => 'The metadata for the database.
', 'UpdateDatabaseRequest$DatabaseInput' => 'A DatabaseInput
object specifying the new definition of the metadata database in the catalog.
A list of Database
objects from the specified catalog.
The database where the table resides.
', 'Crawler$DatabaseName' => 'The name of the database in which the crawler\'s output is stored.
', 'CreateCrawlerRequest$DatabaseName' => 'The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*
.
The name of the database where the table resides.
', 'StopColumnStatisticsTaskRunRequest$DatabaseName' => 'The name of the database where the table resides.
', 'UpdateCrawlerRequest$DatabaseName' => 'The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*
.
A structure representing the datatype of the value.
', 'refs' => [ 'NullValueField$Datatype' => 'The datatype of the value.
', ], ], 'DateColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for timestamp data columns.
', 'refs' => [ 'ColumnStatisticsData$DateColumnStatisticsData' => 'Date column statistics data.
', ], ], 'DecimalColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for fixed-point number data columns.
', 'refs' => [ 'ColumnStatisticsData$DecimalColumnStatisticsData' => 'Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two\'s complement representations of the decimal\'s unscaled value.
', ], ], 'DecimalNumber' => [ 'base' => 'Contains a numeric value in decimal format.
', 'refs' => [ 'DecimalColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DecimalColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'DeleteBehavior' => [ 'base' => NULL, 'refs' => [ 'SchemaChangePolicy$DeleteBehavior' => 'The deletion behavior when the crawler finds a deleted object.
', ], ], 'DeleteBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionNameList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionRequest$ConnectionNameList' => 'A list of names of the connections to delete.
', ], ], 'DeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomEntityTypeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityRulesetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityRulesetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatabaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDevEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDevEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMLTransformRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMLTransformResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistryInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableOptimizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableOptimizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUsageProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUsageProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeltaTarget' => [ 'base' => 'Specifies a Delta data store to crawl one or more Delta tables.
', 'refs' => [ 'DeltaTargetList$member' => NULL, ], ], 'DeltaTargetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3DeltaDirectTarget$Compression' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Specifies Delta data store targets.
', ], ], 'DescriptionString' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$ErrorMessage' => 'The error message for the job.
', 'Connection$Description' => 'The description of the connection.
', 'ConnectionInput$Description' => 'The description of the connection.
', 'Crawl$ErrorMessage' => 'The error message associated with the crawl.
', 'Crawler$Description' => 'A description of the crawler.
', 'CrawlerHistory$ErrorMessage' => 'If an error occurred, the error message associated with the crawl.
', 'CreateCrawlerRequest$Description' => 'A description of the new crawler.
', 'CreateDataQualityRulesetRequest$Description' => 'A description of the data quality ruleset.
', 'CreateJobRequest$Description' => 'Description of the job being defined.
', 'CreateMLTransformRequest$Description' => 'A description of the machine learning transform that is being defined. The default is an empty string.
', 'CreateRegistryInput$Description' => 'A description of the registry. If description is not provided, there will not be any default value for this.
', 'CreateRegistryResponse$Description' => 'A description of the registry.
', 'CreateSchemaInput$Description' => 'An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
', 'CreateSchemaResponse$Description' => 'A description of the schema if specified when created.
', 'CreateSessionRequest$Description' => 'The description of the session.
', 'CreateTriggerRequest$Description' => 'A description of the new trigger.
', 'CreateUsageProfileRequest$Description' => 'A description of the usage profile.
', 'DataQualityRulesetFilterCriteria$Description' => 'The description of the ruleset filter criteria.
', 'DataQualityRulesetListDetails$Description' => 'A description of the data quality ruleset.
', 'Database$Description' => 'A description of the database.
', 'DatabaseInput$Description' => 'A description of the database.
', 'ErrorDetail$ErrorMessage' => 'A message describing the error.
', 'GetDataQualityRulesetResponse$Description' => 'A description of the ruleset.
', 'GetMLTransformResponse$Description' => 'A description of the transform.
', 'GetRegistryResponse$Description' => 'A description of the registry.
', 'GetSchemaResponse$Description' => 'A description of schema if specified when created
', 'GetUsageProfileResponse$Description' => 'A description of the usage profile.
', 'GlueTableAdditionalOptions$value' => NULL, 'Job$Description' => 'A description of the job.
', 'JobUpdate$Description' => 'Description of the job being defined.
', 'LastCrawlInfo$ErrorMessage' => 'If an error occurred, the error information about the last crawl.
', 'MLTransform$Description' => 'A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
', 'RegistryListItem$Description' => 'A description of the registry.
', 'SchemaListItem$Description' => 'A description for the schema.
', 'Session$ErrorMessage' => 'The error message displayed during the session.
', 'Session$Description' => 'The description of the session.
', 'Table$Description' => 'A description of the table.
', 'TableInput$Description' => 'A description of the table.
', 'Trigger$Description' => 'A description of this trigger.
', 'TriggerUpdate$Description' => 'A description of this trigger.
', 'UpdateDataQualityRulesetRequest$Description' => 'A description of the ruleset.
', 'UpdateDataQualityRulesetResponse$Description' => 'A description of the ruleset.
', 'UpdateMLTransformRequest$Description' => 'A description of the transform. The default is an empty string.
', 'UpdateRegistryInput$Description' => 'A description of the registry. If description is not provided, this field will not be updated.
', 'UpdateSchemaInput$Description' => 'The new description for the schema.
', 'UpdateUsageProfileRequest$Description' => 'A description of the usage profile.
', 'UsageProfileDefinition$Description' => 'A description of the usage profile.
', ], ], 'DescriptionStringRemovable' => [ 'base' => NULL, 'refs' => [ 'UpdateCrawlerRequest$Description' => 'A description of the new crawler.
', ], ], 'DevEndpoint' => [ 'base' => 'A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.
', 'refs' => [ 'DevEndpointList$member' => NULL, 'GetDevEndpointResponse$DevEndpoint' => 'A DevEndpoint
definition.
Custom libraries to be loaded into a development endpoint.
', 'refs' => [ 'UpdateDevEndpointRequest$CustomLibraries' => 'Custom Python or Java libraries to be loaded in the DevEndpoint
.
A list of DevEndpoint
definitions.
A list of DevEndpoint
definitions.
The names of all the DevEndpoint
s in the account, or the DevEndpoint
s with the specified tags.
The list of DevEndpoint
names, which might be the names returned from the ListDevEndpoint
operation.
A list of DevEndpoints
not found.
Specifies the direct JDBC source connection.
', 'refs' => [ 'CodeGenConfigurationNode$DirectJDBCSource' => NULL, ], ], 'DirectKafkaSource' => [ 'base' => 'Specifies an Apache Kafka data store.
', 'refs' => [ 'CodeGenConfigurationNode$DirectKafkaSource' => 'Specifies an Apache Kafka data store.
', ], ], 'DirectKinesisSource' => [ 'base' => 'Specifies a direct Amazon Kinesis data source.
', 'refs' => [ 'CodeGenConfigurationNode$DirectKinesisSource' => 'Specifies a direct Amazon Kinesis data source.
', ], ], 'DirectSchemaChangePolicy' => [ 'base' => 'A policy that specifies update behavior for the crawler.
', 'refs' => [ 'S3DeltaDirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3DirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3GlueParquetTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3HudiDirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'DoubleColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DoubleColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'DoubleColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for floating-point number data columns.
', 'refs' => [ 'ColumnStatisticsData$DoubleColumnStatisticsData' => 'Double column statistics data.
', ], ], 'DoubleValue' => [ 'base' => NULL, 'refs' => [ 'Session$Progress' => 'The code execution progress of the session.
', 'Statement$Progress' => 'The code execution progress.
', ], ], 'DropDuplicates' => [ 'base' => 'Specifies a transform that removes rows of repeating data from a data set.
', 'refs' => [ 'CodeGenConfigurationNode$DropDuplicates' => 'Specifies a transform that removes rows of repeating data from a data set.
', ], ], 'DropFields' => [ 'base' => 'Specifies a transform that chooses the data property keys that you want to drop.
', 'refs' => [ 'CodeGenConfigurationNode$DropFields' => 'Specifies a transform that chooses the data property keys that you want to drop.
', ], ], 'DropNullFields' => [ 'base' => 'Specifies a transform that removes columns from the dataset if all values in the column are \'null\'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
', 'refs' => [ 'CodeGenConfigurationNode$DropNullFields' => 'Specifies a transform that removes columns from the dataset if all values in the column are \'null\'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
', ], ], 'DynamicTransform' => [ 'base' => 'Specifies the set of parameters needed to perform the dynamic transform.
', 'refs' => [ 'CodeGenConfigurationNode$DynamicTransform' => 'Specifies a custom visual transform created by a user.
', ], ], 'DynamoDBCatalogSource' => [ 'base' => 'Specifies a DynamoDB data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$DynamoDBCatalogSource' => 'Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
', ], ], 'DynamoDBTarget' => [ 'base' => 'Specifies an Amazon DynamoDB table to crawl.
', 'refs' => [ 'DynamoDBTargetList$member' => NULL, ], ], 'DynamoDBTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$DynamoDBTargets' => 'Specifies Amazon DynamoDB targets.
', ], ], 'Edge' => [ 'base' => 'An edge represents a directed connection between two Glue components that are part of the workflow the edge belongs to.
', 'refs' => [ 'EdgeList$member' => NULL, ], ], 'EdgeList' => [ 'base' => NULL, 'refs' => [ 'WorkflowGraph$Edges' => 'A list of all the directed connections between the nodes belonging to the workflow.
', ], ], 'EnableAdditionalMetadata' => [ 'base' => NULL, 'refs' => [ 'JdbcTarget$EnableAdditionalMetadata' => 'Specify a value of RAWTYPES
or COMMENTS
to enable additional metadata in table responses. RAWTYPES
provides the native-level datatype. COMMENTS
provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
', ], ], 'EnableHybridValues' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$EnableHybrid' => 'If \'TRUE\'
, indicates that you are using both methods to grant cross-account access to Data Catalog resources:
By directly updating the resource policy with PutResourePolicy
By using the Grant permissions command on the Amazon Web Services Management Console.
Must be set to \'TRUE\'
if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is \'FALSE\'.
Specifies the column on the data set on which the aggregation function will be applied.
', 'FilterValue$Value' => 'The value to be associated.
', 'GlueStudioPathList$member' => NULL, 'JDBCConnectorOptions$JobBookmarkKeys' => 'The name of the job bookmark keys on which to sort.
', 'Mapping$FromPath' => 'The table or column to be modified.
', 'PIIDetection$EntityTypesToDetect' => 'Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
', 'RenameField$SourcePath' => 'A JSON path to a variable in the data structure for the source data.
', 'RenameField$TargetPath' => 'A JSON path to a variable in the data structure for the target data.
', 'S3CsvSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3CsvSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'S3DeltaSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3HudiSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3JsonSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3JsonSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'S3ParquetSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3ParquetSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'TransformConfigParameter$Value' => 'Specifies the value of the parameter in the config file of the dynamic transform.
', ], ], 'EnclosedInStringPropertiesMinOne' => [ 'base' => NULL, 'refs' => [ 'UpsertRedshiftTargetOptions$UpsertKeys' => 'The keys used to determine whether to perform an update or insert.
', ], ], 'EnclosedInStringProperty' => [ 'base' => NULL, 'refs' => [ 'AdditionalOptions$key' => NULL, 'AdditionalOptions$value' => NULL, 'AmazonRedshiftNodeData$TempDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'AthenaConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'AthenaConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'AthenaConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
', 'AthenaConnectorSource$SchemaName' => 'The name of the Cloudwatch log group to read from. For example, /aws-glue/jobs/output
.
The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
', 'BasicCatalogTarget$Table' => 'The table that defines the schema of your output data. This table must already exist in the Data Catalog.
', 'CatalogDeltaSource$Database' => 'The name of the database to read from.
', 'CatalogDeltaSource$Table' => 'The name of the table in the database to read from.
', 'CatalogHudiSource$Database' => 'The name of the database to read from.
', 'CatalogHudiSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKafkaSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKafkaSource$Database' => 'The name of the database to read from.
', 'CatalogKinesisSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKinesisSource$Database' => 'The name of the database to read from.
', 'CatalogSource$Database' => 'The name of the database to read from.
', 'CatalogSource$Table' => 'The name of the table in the database to read from.
', 'ConnectorDataSource$ConnectionType' => 'The connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:
opensearch
azuresql
azurecosmos
bigquery
saphana
teradata
vertica
The connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:
opensearch
azuresql
azurecosmos
bigquery
saphana
teradata
vertica
The name defined for the custom code node class.
', 'DQDLAliases$value' => NULL, 'DQResultsPublishingOptions$ResultsS3Prefix' => 'The Amazon S3 prefix prepended to the results.
', 'DirectJDBCSource$Database' => 'The database of the JDBC source connection.
', 'DirectJDBCSource$Table' => 'The table of the JDBC source connection.
', 'DirectJDBCSource$ConnectionName' => 'The connection name of the JDBC source.
', 'DirectJDBCSource$RedshiftTmpDir' => 'The temp directory of the JDBC Redshift source.
', 'DirectSchemaChangePolicy$Table' => 'Specifies the table in the database that the schema change policy applies to.
', 'DirectSchemaChangePolicy$Database' => 'Specifies the database that the schema change policy applies to.
', 'DynamicTransform$Name' => 'Specifies the name of the dynamic transform.
', 'DynamicTransform$TransformName' => 'Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
', 'DynamicTransform$FunctionName' => 'Specifies the name of the function of the dynamic transform.
', 'DynamicTransform$Path' => 'Specifies the path of the dynamic transform source and config files.
', 'DynamicTransform$Version' => 'This field is not used and will be deprecated in future release.
', 'DynamoDBCatalogSource$Database' => 'The name of the database to read from.
', 'DynamoDBCatalogSource$Table' => 'The name of the table in the database to read from.
', 'EnclosedInStringProperties$member' => NULL, 'EnclosedInStringPropertiesMinOne$member' => NULL, 'FillMissingValues$ImputedPath' => 'A JSON path to a variable in the data structure for the dataset that is imputed.
', 'FillMissingValues$FilledPath' => 'A JSON path to a variable in the data structure for the dataset that is filled.
', 'GovernedCatalogSource$Database' => 'The database to read from.
', 'GovernedCatalogSource$Table' => 'The database table to read from.
', 'GovernedCatalogSource$PartitionPredicate' => 'Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to ""
– empty by default.
The name of the table in the database to write to.
', 'GovernedCatalogTarget$Database' => 'The name of the database to write to.
', 'JDBCConnectorOptions$FilterPredicate' => 'Extra condition clause to filter data from source. For example:
BillingCity=\'Mountain View\'
When using a query instead of a table name, you should validate that the query works with the specified filterPredicate
.
The name of an integer column that is used for partitioning. This option works only when it\'s included with lowerBound
, upperBound
, and numPartitions
. This option works the same way as in the Spark SQL JDBC reader.
Specifies an ascending or descending sort order.
', 'JDBCConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'JDBCConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'JDBCConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
', 'JDBCConnectorTarget$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'JDBCConnectorTarget$ConnectorName' => 'The name of a connector that will be used.
', 'JDBCConnectorTarget$ConnectionType' => 'The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
', 'JoinColumn$From' => 'The column to be joined.
', 'KafkaStreamingSourceOptions$BootstrapServers' => 'A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
The protocol used to communicate with brokers. The possible values are "SSL"
or "PLAINTEXT"
.
The name of the connection.
', 'KafkaStreamingSourceOptions$TopicName' => 'The topic name as specified in Apache Kafka. You must specify at least one of "topicName"
, "assign"
or "subscribePattern"
.
The specific TopicPartitions
to consume. You must specify at least one of "topicName"
, "assign"
or "subscribePattern"
.
A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName"
, "assign"
or "subscribePattern"
.
An optional classification.
', 'KafkaStreamingSourceOptions$Delimiter' => 'Specifies the delimiter character.
', 'KafkaStreamingSourceOptions$StartingOffsets' => 'The starting position in the Kafka topic to read data from. The possible values are "earliest"
or "latest"
. The default value is "latest"
.
The end point when a batch query is ended. Possible values are either "latest"
or a JSON string that specifies an ending offset for each TopicPartition
.
When this option is set to \'true\', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KafkaStreamingSourceOptions$EmitConsumerLagMetrics' => 'When this option is set to \'true\', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric\'s name is "glue.driver.streaming.maxConsumerLagInMs". The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KinesisStreamingSourceOptions$EndpointUrl' => 'The URL of the Kinesis endpoint.
', 'KinesisStreamingSourceOptions$StreamName' => 'The name of the Kinesis data stream.
', 'KinesisStreamingSourceOptions$Classification' => 'An optional classification.
', 'KinesisStreamingSourceOptions$Delimiter' => 'Specifies the delimiter character.
', 'KinesisStreamingSourceOptions$StreamArn' => 'The Amazon Resource Name (ARN) of the Kinesis data stream.
', 'KinesisStreamingSourceOptions$RoleArn' => 'The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName"
.
An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN"
.
When this option is set to \'true\', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KinesisStreamingSourceOptions$EmitConsumerLagMetrics' => 'When this option is set to \'true\', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric\'s name is "glue.driver.streaming.maxConsumerLagInMs". The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'Mapping$ToKey' => 'After the apply mapping, what the name of the column should be. Can be the same as FromPath
.
The type of the data to be modified.
', 'Mapping$ToType' => 'The data type that the data is to be modified to.
', 'MicrosoftSQLServerCatalogSource$Database' => 'The name of the database to read from.
', 'MicrosoftSQLServerCatalogSource$Table' => 'The name of the table in the database to read from.
', 'MicrosoftSQLServerCatalogTarget$Database' => 'The name of the database to write to.
', 'MicrosoftSQLServerCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'MySQLCatalogSource$Database' => 'The name of the database to read from.
', 'MySQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'MySQLCatalogTarget$Database' => 'The name of the database to write to.
', 'MySQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'NullValueField$Value' => 'The value of the null placeholder.
', 'Option$Value' => 'Specifies the value of the option.
', 'Option$Label' => 'Specifies the label of the option.
', 'Option$Description' => 'Specifies the description of the option.
', 'OracleSQLCatalogSource$Database' => 'The name of the database to read from.
', 'OracleSQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'OracleSQLCatalogTarget$Database' => 'The name of the database to write to.
', 'OracleSQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'PIIDetection$OutputColumnName' => 'Indicates the output column name that will contain any entity type detected in that row.
', 'PostgreSQLCatalogSource$Database' => 'The name of the database to read from.
', 'PostgreSQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'PostgreSQLCatalogTarget$Database' => 'The name of the database to write to.
', 'PostgreSQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'RecipeReference$RecipeArn' => 'The ARN of the DataBrew recipe.
', 'RedshiftSource$Database' => 'The database to read from.
', 'RedshiftSource$Table' => 'The database table to read from.
', 'RedshiftSource$RedshiftTmpDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'RedshiftSource$TmpDirIAMRole' => 'The IAM role with permissions.
', 'RedshiftTarget$Database' => 'The name of the database to write to.
', 'RedshiftTarget$Table' => 'The name of the table in the database to write to.
', 'RedshiftTarget$RedshiftTmpDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'RedshiftTarget$TmpDirIAMRole' => 'The IAM role with permissions.
', 'RelationalCatalogSource$Database' => 'The name of the database to read from.
', 'RelationalCatalogSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogDeltaSource$Database' => 'The name of the database to read from.
', 'S3CatalogDeltaSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogHudiSource$Database' => 'The name of the database to read from.
', 'S3CatalogHudiSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogSource$Database' => 'The database to read from.
', 'S3CatalogSource$Table' => 'The database table to read from.
', 'S3CatalogSource$PartitionPredicate' => 'Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to ""
– empty by default.
The name of the table in the database to write to.
', 'S3CatalogTarget$Database' => 'The name of the database to write to.
', 'S3CsvSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles"
must be set to "inPartition"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none"
.
The name of the table in the database to write to.
', 'S3DeltaCatalogTarget$Database' => 'The name of the database to write to.
', 'S3DeltaDirectTarget$Path' => 'The Amazon S3 path of your Delta Lake data source to write to.
', 'S3DirectSourceAdditionalOptions$SamplePath' => 'If enabled, specifies the sample path.
', 'S3DirectTarget$Path' => 'A single Amazon S3 path to write to.
', 'S3DirectTarget$Compression' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
A single Amazon S3 path to write to.
', 'S3HudiCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'S3HudiCatalogTarget$Database' => 'The name of the database to write to.
', 'S3HudiDirectTarget$Path' => 'The Amazon S3 path of your Hudi data source to write to.
', 'S3JsonSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles"
must be set to "inPartition"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none"
.
A JsonPath string defining the JSON data.
', 'S3ParquetSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles"
must be set to "inPartition"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none"
.
Not currently used.
', 'SparkConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'SparkConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'SparkConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
', 'SparkConnectorTarget$ConnectionName' => 'The name of a connection for an Apache Spark connector.
', 'SparkConnectorTarget$ConnectorName' => 'The name of an Apache Spark connector.
', 'SparkConnectorTarget$ConnectionType' => 'The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
', 'Spigot$Path' => 'A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
', 'TransformConfigParameter$Name' => 'Specifies the name of the parameter in the config file of the dynamic transform.
', 'TransformConfigParameter$ValidationRule' => 'Specifies the validation rule in the config file of the dynamic transform.
', 'TransformConfigParameter$ValidationMessage' => 'Specifies the validation message in the config file of the dynamic transform.
', 'UpsertRedshiftTargetOptions$TableLocation' => 'The physical location of the Redshift table.
', 'UpsertRedshiftTargetOptions$ConnectionName' => 'The name of the connection to use to write to Redshift.
', ], ], 'EnclosedInStringPropertyWithQuote' => [ 'base' => NULL, 'refs' => [ 'AthenaConnectorSource$ConnectionTable' => 'The name of the table in the data source.
', 'JDBCConnectorSource$ConnectionTable' => 'The name of the table in the data source.
', 'JDBCConnectorTarget$ConnectionTable' => 'The name of the table in the data target.
', 'S3CsvSource$Escaper' => 'Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none
. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\\n
, \\r
, \\t
, and \\0
).
A temporary name given to a table, or a column in a table.
', ], ], 'EncryptionAtRest' => [ 'base' => 'Specifies the encryption-at-rest configuration for the Data Catalog.
', 'refs' => [ 'DataCatalogEncryptionSettings$EncryptionAtRest' => 'Specifies the encryption-at-rest configuration for the Data Catalog.
', ], ], 'EncryptionConfiguration' => [ 'base' => 'Specifies an encryption configuration.
', 'refs' => [ 'CreateSecurityConfigurationRequest$EncryptionConfiguration' => 'The encryption configuration for the new security configuration.
', 'SecurityConfiguration$EncryptionConfiguration' => 'The encryption configuration associated with this security configuration.
', ], ], 'EntityNotFoundException' => [ 'base' => 'A specified entity does not exist
', 'refs' => [], ], 'ErrorByName' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionResponse$Errors' => 'A map of the names of connections that were not successfully deleted to error details.
', ], ], 'ErrorCodeString' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorCode' => 'The error code for an error.
', ], ], 'ErrorDetail' => [ 'base' => 'Contains details about an error.
', 'refs' => [ 'BatchGetTableOptimizerError$error' => 'An ErrorDetail
object containing code and message details about the error.
Specifies details about the error that was encountered.
', 'BatchUpdatePartitionFailureEntry$ErrorDetail' => 'The details about the batch update partition error.
', 'ColumnError$Error' => 'An error message with the reason for the failure of an operation.
', 'ColumnStatisticsError$Error' => 'An error message with the reason for the failure of an operation.
', 'ErrorByName$value' => NULL, 'PartitionError$ErrorDetail' => 'The details about the partition error.
', 'TableError$ErrorDetail' => 'The details about the error.
', 'TableVersionError$ErrorDetail' => 'The details about the error.
', ], ], 'ErrorDetails' => [ 'base' => 'An object containing error details.
', 'refs' => [ 'SchemaVersionErrorItem$ErrorDetails' => 'The details of the error for the schema version.
', ], ], 'ErrorMessageString' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorMessage' => 'The error message for an error.
', ], ], 'ErrorString' => [ 'base' => NULL, 'refs' => [ 'Blueprint$ErrorMessage' => 'An error message.
', 'JobRun$ErrorMessage' => 'An error message associated with this job run.
', 'WorkflowRun$ErrorMessage' => 'This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo
."
Specifies your data quality evaluation criteria.
', 'refs' => [ 'CodeGenConfigurationNode$EvaluateDataQuality' => 'Specifies your data quality evaluation criteria.
', ], ], 'EvaluateDataQualityMultiFrame' => [ 'base' => 'Specifies your data quality evaluation criteria.
', 'refs' => [ 'CodeGenConfigurationNode$EvaluateDataQualityMultiFrame' => 'Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
', ], ], 'EvaluatedMetricsMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityAnalyzerResult$EvaluatedMetrics' => 'A map of metrics associated with the evaluation of the analyzer.
', 'DataQualityRuleResult$EvaluatedMetrics' => 'A map of metrics associated with the evaluation of the rule.
', ], ], 'EvaluationMetrics' => [ 'base' => 'Evaluation metrics provide an estimate of the quality of your machine learning transform.
', 'refs' => [ 'GetMLTransformResponse$EvaluationMetrics' => 'The latest evaluation metrics.
', 'MLTransform$EvaluationMetrics' => 'An EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'refs' => [ 'CreateTriggerRequest$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'Trigger$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'TriggerUpdate$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', ], ], 'EventQueueArn' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$EventQueueArn' => 'A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs
.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue
.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs
.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue
.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
An execution property of a job.
', 'refs' => [ 'CreateJobRequest$ExecutionProperty' => 'An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
The amount of time (in seconds) that the run consumed resources.
', 'GetDataQualityRulesetEvaluationRunResponse$ExecutionTime' => 'The amount of time (in seconds) that the run consumed resources.
', 'GetMLTaskRunResponse$ExecutionTime' => 'The amount of time (in seconds) that the task run consumed resources.
', 'JobRun$ExecutionTime' => 'The amount of time (in seconds) that the job run consumed resources.
', 'TaskRun$ExecutionTime' => 'The amount of time (in seconds) that the task run consumed resources.
', ], ], 'ExistCondition' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$PolicyExistsCondition' => 'A value of MUST_EXIST
is used to update a policy. A value of NOT_EXIST
is used to create a new policy. If a value of NONE
or a null value is used, the call does not depend on the existence of a policy.
Specifies configuration properties for an exporting labels task run.
', 'refs' => [ 'TaskRunProperties$ExportLabelsTaskRunProperties' => 'The configuration properties for an exporting labels task run.
', ], ], 'ExtendedString' => [ 'base' => NULL, 'refs' => [ 'CustomCode$Code' => 'The custom code that is used to perform the data transformation.
', ], ], 'FederatedDatabase' => [ 'base' => 'A database that points to an entity outside the Glue Data Catalog.
', 'refs' => [ 'Database$FederatedDatabase' => 'A FederatedDatabase
structure that references an entity outside the Glue Data Catalog.
A FederatedDatabase
structure that references an entity outside the Glue Data Catalog.
A federated resource already exists.
', 'refs' => [], ], 'FederatedTable' => [ 'base' => 'A table that points to an entity outside the Glue Data Catalog.
', 'refs' => [ 'Table$FederatedTable' => 'A FederatedTable
structure that references an entity outside the Glue Data Catalog.
A unique identifier for the federated database.
', 'FederatedTable$Identifier' => 'A unique identifier for the federated table.
', 'FederatedTable$DatabaseIdentifier' => 'A unique identifier for the federated database.
', ], ], 'FederationSourceErrorCode' => [ 'base' => NULL, 'refs' => [ 'FederationSourceException$FederationSourceErrorCode' => 'The error code of the problem.
', ], ], 'FederationSourceException' => [ 'base' => 'A federation source failed.
', 'refs' => [], ], 'FederationSourceRetryableException' => [ 'base' => 'A federation source failed, but the operation may be retried.
', 'refs' => [], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'CrawlsFilter$FieldName' => 'A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:
CRAWL_ID
: A string representing the UUID identifier for a crawl.
STATE
: A string representing the state of the crawl.
START_TIME
and END_TIME
: The epoch timestamp in milliseconds.
DPU_HOUR
: The number of data processing unit (DPU) hours used for the crawl.
The source type.
', 'MappingEntry$TargetType' => 'The target type.
', ], ], 'FillMissingValues' => [ 'base' => 'Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
', 'refs' => [ 'CodeGenConfigurationNode$FillMissingValues' => 'Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
', ], ], 'Filter' => [ 'base' => 'Specifies a transform that splits a dataset into two, based on a filter condition.
', 'refs' => [ 'CodeGenConfigurationNode$Filter' => 'Specifies a transform that splits a dataset into two, based on a filter condition.
', ], ], 'FilterExpression' => [ 'base' => 'Specifies a filter expression.
', 'refs' => [ 'FilterExpressions$member' => NULL, ], ], 'FilterExpressions' => [ 'base' => NULL, 'refs' => [ 'Filter$Filters' => 'Specifies a filter expression.
', ], ], 'FilterLogicalOperator' => [ 'base' => NULL, 'refs' => [ 'Filter$LogicalOperator' => 'The operator used to filter rows by comparing the key value to a specified value.
', ], ], 'FilterOperation' => [ 'base' => NULL, 'refs' => [ 'FilterExpression$Operation' => 'The type of operation to perform in the expression.
', ], ], 'FilterOperator' => [ 'base' => NULL, 'refs' => [ 'CrawlsFilter$FilterOperator' => 'A defined comparator that operates on the value. The available operators are:
GT
: Greater than.
GE
: Greater than or equal to.
LT
: Less than.
LE
: Less than or equal to.
EQ
: Equal to.
NE
: Not equal to.
A regular expression pattern. If present, only those tables whose names match the pattern are returned.
', ], ], 'FilterValue' => [ 'base' => 'Represents a single entry in the list of values for a FilterExpression
.
The type of filter value.
', ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'FilterExpression$Values' => 'A list of filter values.
', ], ], 'FindMatchesMetrics' => [ 'base' => 'The evaluation metrics for the find matches algorithm. The quality of your machine learning transform is measured by getting your transform to predict some matches and comparing the results to known matches from the same dataset. The quality metrics are based on a subset of your data, so they are not precise.
', 'refs' => [ 'EvaluationMetrics$FindMatchesMetrics' => 'The evaluation metrics for the find matches algorithm.
', ], ], 'FindMatchesParameters' => [ 'base' => 'The parameters to configure the find matches transform.
', 'refs' => [ 'TransformParameters$FindMatchesParameters' => 'The parameters for the find matches algorithm.
', ], ], 'FindMatchesTaskRunProperties' => [ 'base' => 'Specifies configuration properties for a Find Matches task run.
', 'refs' => [ 'TaskRunProperties$FindMatchesTaskRunProperties' => 'The configuration properties for a find matches task run.
', ], ], 'FormatString' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$InputFormat' => 'The input format: SequenceFileInputFormat
(binary), or TextInputFormat
, or a custom format.
The output format: SequenceFileOutputFormat
(binary), or IgnoreKeyTextOutputFormat
, or a custom format.
The description of the blueprint.
', 'CreateBlueprintRequest$Description' => 'A description of the blueprint.
', 'LastActiveDefinition$Description' => 'The description of the blueprint.
', 'SourceControlDetails$Repository' => 'The name of the remote repository that contains the job artifacts.
', 'SourceControlDetails$Owner' => 'The owner of the remote repository that contains the job artifacts.
', 'SourceControlDetails$Branch' => 'An optional branch in the remote repository.
', 'SourceControlDetails$Folder' => 'An optional folder in the remote repository.
', 'SourceControlDetails$LastCommitId' => 'The last commit ID for a commit in the remote repository.
', 'SourceControlDetails$AuthToken' => 'The value of an authorization token.
', 'UpdateBlueprintRequest$Description' => 'A description of the blueprint.
', ], ], 'GenericBoundedDouble' => [ 'base' => NULL, 'refs' => [ 'ColumnImportance$Importance' => 'The column importance score for the column, as a decimal.
', 'DataQualityResult$Score' => 'An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
', 'FindMatchesMetrics$AreaUnderPRCurve' => 'The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$Precision' => 'The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$Recall' => 'The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$F1' => 'The maximum F1 metric indicates the transform\'s accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
', 'FindMatchesParameters$PrecisionRecallTradeoff' => 'The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
', 'FindMatchesParameters$AccuracyCostTradeoff' => 'The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches
transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
', 'GetDataQualityResultResponse$Score' => 'An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
', ], ], 'GenericLimitedString' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$AccessType' => 'The access type for the Redshift connection. Can be a direct connection or catalog connections.
', 'AmazonRedshiftNodeData$SourceType' => 'The source type to specify whether a specific table is the source or a custom query.
', 'AmazonRedshiftNodeData$TablePrefix' => 'Specifies the prefix to a table.
', 'AmazonRedshiftNodeData$MergeAction' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled.
', 'AmazonRedshiftNodeData$MergeWhenMatched' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
', 'AmazonRedshiftNodeData$MergeWhenNotMatched' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn\'t match a new record.
', 'DQResultsPublishingOptions$EvaluationContext' => 'The context of the evaluation.
', 'Datatype$Id' => 'The datatype of the value.
', 'Datatype$Label' => 'A label assigned to the datatype.
', 'LimitedStringList$member' => NULL, 'SnowflakeNodeData$SourceType' => 'Specifies how retrieved data is specified. Valid values: "table"
, "query"
.
Specifies a merge action. Valid values: simple
, custom
. If simple, merge behavior is defined by MergeWhenMatched
and MergeWhenNotMatched
. If custom, defined by MergeClause
.
Specifies how to resolve records that match preexisting data when merging. Valid values: update
, delete
.
Specifies how to process records that do not match preexisting data when merging. Valid values: insert
, none
.
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
', 'CreateJobRequest$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'CreateJobRequest$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'Job$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'Job$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'JobRun$Arguments' => 'The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'JobUpdate$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'JobUpdate$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'StartJobRunRequest$Arguments' => 'The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', ], ], 'GenericString' => [ 'base' => NULL, 'refs' => [ 'AdditionalPlanOptionsMap$key' => NULL, 'AdditionalPlanOptionsMap$value' => NULL, 'AmazonRedshiftAdvancedOption$Key' => 'The key for the additional connection option.
', 'AmazonRedshiftAdvancedOption$Value' => 'The value for the additional connection option.
', 'AmazonRedshiftNodeData$CatalogRedshiftSchema' => 'The Redshift schema name when working with a data catalog.
', 'AmazonRedshiftNodeData$CatalogRedshiftTable' => 'The database table to read from.
', 'AmazonRedshiftNodeData$SampleQuery' => 'The SQL used to fetch the data from a Redshift sources when the SourceType is \'query\'.
', 'AmazonRedshiftNodeData$PreAction' => 'The SQL used before a MERGE or APPEND with upsert is run.
', 'AmazonRedshiftNodeData$PostAction' => 'The SQL used before a MERGE or APPEND with upsert is run.
', 'AmazonRedshiftNodeData$Action' => 'Specifies how writing to a Redshift cluser will occur.
', 'AmazonRedshiftNodeData$MergeClause' => 'The SQL used in a custom merge to deal with matching records.
', 'AmazonRedshiftNodeData$CrawlerConnection' => 'Specifies the name of the connection that is associated with the catalog table used.
', 'AmazonRedshiftNodeData$StagingTable' => 'The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
', 'Blueprint$BlueprintLocation' => 'Specifies the path in Amazon S3 where the blueprint is published.
', 'Blueprint$BlueprintServiceLocation' => 'Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint
to register the blueprint in Glue.
The value provided for comparison on the crawl field.
', 'CreateDevEndpointRequest$EndpointName' => 'The name to be assigned to the new DevEndpoint
.
The subnet ID for the new DevEndpoint
to use.
The public key to be used by this DevEndpoint
for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint
. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.
The path to one or more Java .jar
files in an S3 bucket that should be loaded in your DevEndpoint
.
The name assigned to the new DevEndpoint
.
The current status of the new DevEndpoint
.
The subnet ID assigned to the new DevEndpoint
.
The address of the YARN endpoint used by this DevEndpoint
.
The Amazon Web Services Availability Zone where this DevEndpoint
is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint
.
The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint
.
Path to one or more Java .jar
files in an S3 bucket that will be loaded in your DevEndpoint
.
The reason for a current failure in this DevEndpoint
.
A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
This field is required when the trigger type is SCHEDULED.
', 'CreateWorkflowRequest$Description' => 'A description of the workflow.
', 'DQAdditionalOptions$value' => NULL, 'DataQualityResult$EvaluationContext' => 'In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext
can differentiate the nodes.
The name of the DevEndpoint
.
The name of the DevEndpoint
.
The subnet ID for this DevEndpoint
.
The YARN endpoint address used by this DevEndpoint
.
A private IP address to access the DevEndpoint
within a VPC if the DevEndpoint
is created within one. The PrivateAddress
field is present only when you create the DevEndpoint
within your VPC.
The public IP address used by this DevEndpoint
. The PublicAddress
field is present only when you create a non-virtual private cloud (VPC) DevEndpoint
.
The current status of this DevEndpoint
.
The Amazon Web Services Availability Zone where this DevEndpoint
is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint
.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint
. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar
files in an S3 bucket that should be loaded in your DevEndpoint
.
You can only use pure Java/Scala libraries with a DevEndpoint
.
The reason for a current failure in this DevEndpoint
.
The status of the last update.
', 'DevEndpoint$PublicKey' => 'The public key to be used by this DevEndpoint
for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be loaded in your DevEndpoint
. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar
files in an S3 bucket that should be loaded in your DevEndpoint
.
You can only use pure Java/Scala libraries with a DevEndpoint
.
A continuation token, if this is a continuation request.
', 'GetBlueprintRunsResponse$NextToken' => 'A continuation token, if not all blueprint runs have been returned.
', 'GetDataQualityResultResponse$EvaluationContext' => 'In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext
can differentiate the nodes.
The error strings that are associated with the run.
', 'GetDataQualityRulesetEvaluationRunResponse$ErrorString' => 'The error strings that are associated with the run.
', 'GetDevEndpointRequest$EndpointName' => 'Name of the DevEndpoint
to retrieve information for.
A continuation token, if this is a continuation call.
', 'GetDevEndpointsResponse$NextToken' => 'A continuation token, if not all DevEndpoint
definitions have yet been returned.
A continuation token, if this is a continuation call.
', 'GetJobRunsResponse$NextToken' => 'A continuation token, if not all requested job runs have been returned.
', 'GetJobsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetJobsResponse$NextToken' => 'A continuation token, if not all job definitions have yet been returned.
', 'GetMLTaskRunResponse$LogGroupName' => 'The names of the log groups that are associated with the task run.
', 'GetMLTaskRunResponse$ErrorString' => 'The error strings that are associated with the task run.
', 'GetSecurityConfigurationsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetSecurityConfigurationsResponse$NextToken' => 'A continuation token, if there are more security configurations to return.
', 'GetTriggersRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetTriggersResponse$NextToken' => 'A continuation token, if not all the requested triggers have yet been returned.
', 'GetWorkflowRunsRequest$NextToken' => 'The maximum size of the response.
', 'GetWorkflowRunsResponse$NextToken' => 'A continuation token, if not all requested workflow runs have been returned.
', 'JobCommand$Name' => 'The name of the job command. For an Apache Spark ETL job, this must be glueetl
. For a Python shell job, it must be pythonshell
. For an Apache Spark streaming ETL job, this must be gluestreaming
. For a Ray job, this must be glueray
.
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/
, in which case the default encryption is NONE
. If you add a role name and SecurityConfiguration
name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.
Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
', 'LastActiveDefinition$BlueprintServiceLocation' => 'Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
', 'ListBlueprintsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListBlueprintsResponse$NextToken' => 'A continuation token, if not all blueprint names have been returned.
', 'ListDevEndpointsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListDevEndpointsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListJobsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListJobsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListTriggersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListTriggersResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListWorkflowsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListWorkflowsResponse$NextToken' => 'A continuation token, if not all workflow names have been returned.
', 'MapValue$key' => NULL, 'MapValue$value' => NULL, 'OrchestrationStringList$member' => NULL, 'PublicKeysList$member' => NULL, 'SnowflakeNodeData$Schema' => 'Specifies a Snowflake database schema for your node to use.
', 'SnowflakeNodeData$Table' => 'Specifies a Snowflake table for your node to use.
', 'SnowflakeNodeData$Database' => 'Specifies a Snowflake database for your node to use.
', 'SnowflakeNodeData$SampleQuery' => 'A SQL string used to retrieve data with the query
sourcetype.
A SQL string run before the Snowflake connector performs its standard actions.
', 'SnowflakeNodeData$PostAction' => 'A SQL string run after the Snowflake connector performs its standard actions.
', 'SnowflakeNodeData$Action' => 'Specifies what action to take when writing to a table with preexisting data. Valid values: append
, merge
, truncate
, drop
.
A SQL statement that specifies a custom merge behavior.
', 'SnowflakeNodeData$StagingTable' => 'The name of a staging table used when performing merge
or upsert append
actions. Data is written to this table, then moved to table
by a generated postaction.
The execution code of the statement.
', 'StatementOutput$ErrorName' => 'The name of the error in the output.
', 'StatementOutput$ErrorValue' => 'The error value of the output.
', 'StatementOutputData$TextPlain' => 'The code execution output in text format.
', 'StringList$member' => NULL, 'TaskRun$LogGroupName' => 'The names of the log group for secure logging, associated with this task run.
', 'TaskRun$ErrorString' => 'The list of error strings associated with this task run.
', 'Trigger$Schedule' => 'A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
The name of the DevEndpoint
to be updated.
The public key for the DevEndpoint
to use.
The description of the workflow.
', 'Workflow$Description' => 'A description of the workflow.
', 'WorkflowRunProperties$value' => NULL, ], ], 'GetBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCatalogImportStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCatalogImportStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifiersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifiersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionRequest$ColumnNames' => 'A list of the column names.
', 'GetColumnStatisticsForTableRequest$ColumnNames' => 'A list of the column names.
', ], ], 'GetColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsTaskRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsTaskRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsFilter' => [ 'base' => 'Filters the connection definitions that are returned by the GetConnections
API operation.
A filter that controls which connections are returned.
', ], ], 'GetConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomEntityTypeResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataCatalogEncryptionSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataCatalogEncryptionSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataflowGraphRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataflowGraphResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobBookmarkRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobBookmarkResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMappingResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionIndexesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionIndexesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRegistryInput' => [ 'base' => NULL, 'refs' => [], ], 'GetRegistryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesResponseList' => [ 'base' => NULL, 'refs' => [ 'GetResourcePoliciesResponse$GetResourcePoliciesResponseList' => 'A list of the individual resource policies and the account-level resource policy.
', ], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaByDefinitionInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaByDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionsDiffInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionsDiffResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableOptimizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableOptimizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetTableVersionsResponse$TableVersions' => 'A list of strings identifying available versions of the specified table.
', ], ], 'GetTableVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTablesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTablesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionsMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionsMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredTableMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredTableMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUsageProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUsageProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GlueEncryptionException' => [ 'base' => 'An encryption operation failed.
', 'refs' => [], ], 'GluePolicy' => [ 'base' => 'A structure for returning a resource policy.
', 'refs' => [ 'GetResourcePoliciesResponseList$member' => NULL, ], ], 'GlueRecordType' => [ 'base' => NULL, 'refs' => [ 'JDBCDataTypeMapping$value' => NULL, ], ], 'GlueResourceArn' => [ 'base' => NULL, 'refs' => [ 'CreateRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the newly created registry.
', 'CreateSchemaResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'CreateSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'DeleteRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry being deleted.
', 'DeleteResourcePolicyRequest$ResourceArn' => 'The ARN of the Glue resource for the resource policy to be deleted.
', 'DeleteSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema being deleted.
', 'FederatedResourceAlreadyExistsException$AssociatedGlueResource' => 'The associated Glue resource already exists.
', 'GetRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'GetResourcePolicyRequest$ResourceArn' => 'The ARN of the Glue resource for which to retrieve the resource policy. If not supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies
to view all existing resource policies. For more information see Specifying Glue Resource ARNs.
The Amazon Resource Name (ARN) of the schema.
', 'GetSchemaResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'GetSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'GetSchemaVersionResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'GetTagsRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
', 'PutResourcePolicyRequest$ResourceArn' => 'Do not use. For internal use only.
', 'PutSchemaVersionMetadataResponse$SchemaArn' => 'The Amazon Resource Name (ARN) for the schema.
', 'RegistryId$RegistryArn' => 'Arn of the registry to be updated. One of RegistryArn
or RegistryName
has to be provided.
The Amazon Resource Name (ARN) of the registry.
', 'RemoveSchemaVersionMetadataResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'SchemaId$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema. One of SchemaArn
or SchemaName
has to be provided.
The Amazon Resource Name (ARN) for the schema.
', 'SchemaVersionListItem$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'TagResourceRequest$ResourceArn' => 'The ARN of the Glue resource to which to add the tags. For more information about Glue resource ARNs, see the Glue ARN string pattern.
', 'UntagResourceRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource from which to remove the tags.
', 'UpdateRegistryResponse$RegistryArn' => 'The Amazon Resource name (ARN) of the updated registry.
', 'UpdateSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', ], ], 'GlueSchema' => [ 'base' => 'Specifies a user-defined schema when a schema cannot be determined by Glue.
', 'refs' => [ 'GlueSchemas$member' => NULL, ], ], 'GlueSchemas' => [ 'base' => NULL, 'refs' => [ 'AthenaConnectorSource$OutputSchemas' => 'Specifies the data schema for the custom Athena source.
', 'CatalogDeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'CatalogHudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'ConnectorDataSource$OutputSchemas' => 'Specifies the data schema for this source.
', 'CustomCode$OutputSchemas' => 'Specifies the data schema for the custom code transform.
', 'DynamicTransform$OutputSchemas' => 'Specifies the data schema for the dynamic transform.
', 'JDBCConnectorSource$OutputSchemas' => 'Specifies the data schema for the custom JDBC source.
', 'JDBCConnectorTarget$OutputSchemas' => 'Specifies the data schema for the JDBC target.
', 'S3CatalogDeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'S3CatalogHudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'S3CsvSource$OutputSchemas' => 'Specifies the data schema for the S3 CSV source.
', 'S3DeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'S3HudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'S3JsonSource$OutputSchemas' => 'Specifies the data schema for the S3 JSON source.
', 'S3ParquetSource$OutputSchemas' => 'Specifies the data schema for the S3 Parquet source.
', 'SnowflakeSource$OutputSchemas' => 'Specifies user-defined schemas for your output data.
', 'SparkConnectorSource$OutputSchemas' => 'Specifies data schema for the custom spark source.
', 'SparkConnectorTarget$OutputSchemas' => 'Specifies the data schema for the custom spark target.
', 'SparkSQL$OutputSchemas' => 'Specifies the data schema for the SparkSQL transform.
', ], ], 'GlueStudioColumnNameString' => [ 'base' => NULL, 'refs' => [ 'GlueStudioSchemaColumn$Name' => 'The name of the column in the Glue Studio schema.
', ], ], 'GlueStudioPathList' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Groups' => 'Specifies the fields to group by.
', 'DropFields$Paths' => 'A JSON path to a variable in the data structure.
', 'GovernedCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'JoinColumn$Keys' => 'The key of the column to be joined.
', 'Merge$PrimaryKeys' => 'The list of primary key fields to match records from the source and staging dynamic frames.
', 'S3CatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DeltaCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DeltaDirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3GlueParquetTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3HudiCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3HudiDirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'SelectFields$Paths' => 'A JSON path to a variable in the data structure.
', 'SplitFields$Paths' => 'A JSON path to a variable in the data structure.
', ], ], 'GlueStudioSchemaColumn' => [ 'base' => 'Specifies a single column in a Glue schema definition.
', 'refs' => [ 'GlueStudioSchemaColumnList$member' => NULL, ], ], 'GlueStudioSchemaColumnList' => [ 'base' => NULL, 'refs' => [ 'GlueSchema$Columns' => 'Specifies the column definitions that make up a Glue schema.
', ], ], 'GlueTable' => [ 'base' => 'The database and table in the Glue Data Catalog that is used for input or output data.
', 'refs' => [ 'DataSource$GlueTable' => 'An Glue table.
', 'GlueTables$member' => NULL, ], ], 'GlueTableAdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'GlueTable$AdditionalOptions' => 'Additional options for the table. Currently there are two keys supported:
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset.
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
A list of Glue table definitions used by the transform.
', 'GetMLTransformResponse$InputRecordTables' => 'A list of Glue table definitions used by the transform.
', 'MLTransform$InputRecordTables' => 'A list of Glue table definitions used by the transform.
', ], ], 'GlueVersionString' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$GlueVersion' => 'Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
', 'CreateJobRequest$GlueVersion' => 'In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'CreateMLTransformRequest$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'CreateSessionRequest$GlueVersion' => 'The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
', 'DevEndpoint$GlueVersion' => 'Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'Job$GlueVersion' => 'In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'JobRun$GlueVersion' => 'In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'JobUpdate$GlueVersion' => 'In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'MLTransform$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'Session$GlueVersion' => 'The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
', 'TransformFilterCriteria$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'UpdateMLTransformRequest$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', ], ], 'GovernedCatalogSource' => [ 'base' => 'Specifies the data store in the governed Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$GovernedCatalogSource' => 'Specifies a data source in a goverened Data Catalog.
', ], ], 'GovernedCatalogTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$GovernedCatalogTarget' => 'Specifies a data target that writes to a goverened catalog.
', ], ], 'GrokClassifier' => [ 'base' => 'A classifier that uses grok
patterns.
A classifier that uses grok
.
The grok pattern used by this classifier.
', 'GrokClassifier$GrokPattern' => 'The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.
', 'UpdateGrokClassifierRequest$GrokPattern' => 'The grok pattern used by this classifier.
', ], ], 'HashString' => [ 'base' => NULL, 'refs' => [ 'CancelDataQualityRuleRecommendationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'CancelDataQualityRulesetEvaluationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'CancelMLTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'CancelMLTaskRunRequest$TaskRunId' => 'A unique identifier for the task run.
', 'CancelMLTaskRunResponse$TransformId' => 'The unique identifier of the machine learning transform.
', 'CancelMLTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'ColumnStatisticsTaskRun$ColumnStatisticsTaskRunId' => 'The identifier for the particular column statistics task run.
', 'ColumnStatisticsTaskRunIdList$member' => NULL, 'CreateDataQualityRulesetRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'CreateMLTransformResponse$TransformId' => 'A unique identifier that is generated for the transform.
', 'DataQualityResult$ResultId' => 'A unique result ID for the data quality result.
', 'DataQualityResult$JobRunId' => 'The job run ID associated with the data quality result, if any.
', 'DataQualityResult$RulesetEvaluationRunId' => 'The unique run ID for the ruleset evaluation for this data quality result.
', 'DataQualityResultDescription$ResultId' => 'The unique result ID for this data quality result.
', 'DataQualityResultDescription$JobRunId' => 'The job run ID associated with the data quality result.
', 'DataQualityResultFilterCriteria$JobRunId' => 'Filter results by the specified job run ID.
', 'DataQualityResultIdList$member' => NULL, 'DataQualityResultIds$member' => NULL, 'DataQualityRuleRecommendationRunDescription$RunId' => 'The unique run identifier associated with this run.
', 'DataQualityRulesetEvaluationRunDescription$RunId' => 'The unique run identifier associated with this run.
', 'DataQualityRulesetListDetails$RecommendationRunId' => 'When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
', 'DeleteMLTransformRequest$TransformId' => 'The unique identifier of the transform to delete.
', 'DeleteMLTransformResponse$TransformId' => 'The unique identifier of the transform that was deleted.
', 'DeleteResourcePolicyRequest$PolicyHashCondition' => 'The hash value returned when this policy was set.
', 'FindMatchesTaskRunProperties$JobId' => 'The job ID for the Find Matches task run.
', 'FindMatchesTaskRunProperties$JobRunId' => 'The job run ID for the Find Matches task run.
', 'GetColumnStatisticsTaskRunRequest$ColumnStatisticsTaskRunId' => 'The identifier for the particular column statistics task run.
', 'GetDataQualityResultRequest$ResultId' => 'A unique result ID for the data quality result.
', 'GetDataQualityResultResponse$ResultId' => 'A unique result ID for the data quality result.
', 'GetDataQualityResultResponse$JobRunId' => 'The job run ID associated with the data quality result, if any.
', 'GetDataQualityResultResponse$RulesetEvaluationRunId' => 'The unique run ID associated with the ruleset evaluation.
', 'GetDataQualityRuleRecommendationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRuleRecommendationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetEvaluationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetEvaluationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetResponse$RecommendationRunId' => 'When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
', 'GetMLTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'GetMLTaskRunRequest$TaskRunId' => 'The unique identifier of the task run.
', 'GetMLTaskRunResponse$TransformId' => 'The unique identifier of the task run.
', 'GetMLTaskRunResponse$TaskRunId' => 'The unique run identifier associated with this run.
', 'GetMLTaskRunsRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'GetMLTransformRequest$TransformId' => 'The unique identifier of the transform, generated at the time that the transform was created.
', 'GetMLTransformResponse$TransformId' => 'The unique identifier of the transform, generated at the time that the transform was created.
', 'GetResourcePolicyResponse$PolicyHash' => 'Contains the hash value associated with this policy.
', 'GetUnfilteredTableMetadataResponse$QueryAuthorizationId' => 'A cryptographically generated query identifier generated by Glue or Lake Formation.
', 'GluePolicy$PolicyHash' => 'Contains the hash value associated with this policy.
', 'MLTransform$TransformId' => 'The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
', 'PutResourcePolicyRequest$PolicyHashCondition' => 'The hash value returned when the previous policy was set using PutResourcePolicy
. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.
A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.
', 'QuerySessionContext$QueryId' => 'A unique identifier generated by the query engine for the query.
', 'QuerySessionContext$QueryAuthorizationId' => 'A cryptographically generated query identifier generated by Glue or Lake Formation.
', 'StartColumnStatisticsTaskRunResponse$ColumnStatisticsTaskRunId' => 'The identifier for the column statistics task run.
', 'StartDataQualityRuleRecommendationRunRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'StartDataQualityRuleRecommendationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'StartDataQualityRulesetEvaluationRunRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'StartDataQualityRulesetEvaluationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'StartExportLabelsTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartExportLabelsTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'StartImportLabelsTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartImportLabelsTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'StartMLEvaluationTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartMLEvaluationTaskRunResponse$TaskRunId' => 'The unique identifier associated with this run.
', 'StartMLLabelingSetGenerationTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartMLLabelingSetGenerationTaskRunResponse$TaskRunId' => 'The unique run identifier that is associated with this task run.
', 'TaskRun$TransformId' => 'The unique identifier for the transform.
', 'TaskRun$TaskRunId' => 'The unique identifier for this task run.
', 'TransformIdList$member' => NULL, 'UpdateMLTransformRequest$TransformId' => 'A unique identifier that was generated when the transform was created.
', 'UpdateMLTransformResponse$TransformId' => 'The unique identifier for the transform that was updated.
', ], ], 'HudiTarget' => [ 'base' => 'Specifies an Apache Hudi data source.
', 'refs' => [ 'HudiTargetList$member' => NULL, ], ], 'HudiTargetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3HudiDirectTarget$Compression' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Specifies Apache Hudi data store targets.
', ], ], 'IAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRest$CatalogEncryptionServiceRole' => 'The role that Glue assumes to encrypt and decrypt the Data Catalog objects on the caller\'s behalf.
', ], ], 'IcebergInput' => [ 'base' => 'A structure that defines an Apache Iceberg metadata table to create in the catalog.
', 'refs' => [ 'OpenTableFormatInput$IcebergInput' => 'Specifies an IcebergInput
structure that defines an Apache Iceberg metadata table.
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
', 'refs' => [ 'IcebergTargetList$member' => NULL, ], ], 'IcebergTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$IcebergTargets' => 'Specifies Apache Iceberg data store targets.
', ], ], 'IdString' => [ 'base' => NULL, 'refs' => [ 'BatchStopJobRunError$JobRunId' => 'The JobRunId
of the job run in question.
The JobRunId
of the job run that was stopped.
The run ID for this blueprint.
', 'BlueprintRun$RunId' => 'The run ID for this blueprint run.
', 'GetBlueprintRunRequest$RunId' => 'The run ID for the blueprint run you want to retrieve.
', 'GetJobRunRequest$RunId' => 'The ID of the job run.
', 'GetWorkflowRunPropertiesRequest$RunId' => 'The ID of the workflow run whose run properties should be returned.
', 'GetWorkflowRunRequest$RunId' => 'The ID of the workflow run.
', 'JobRun$Id' => 'The ID of this job run.
', 'JobRun$PreviousRunId' => 'The ID of the previous run of this job. For example, the JobRunId
specified in the StartJobRun
action.
The job-run ID of the predecessor job run.
', 'PutWorkflowRunPropertiesRequest$RunId' => 'The ID of the workflow run for which the run properties should be updated.
', 'ResumeWorkflowRunRequest$RunId' => 'The ID of the workflow run to resume.
', 'ResumeWorkflowRunResponse$RunId' => 'The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
', 'StartBlueprintRunResponse$RunId' => 'The run ID for this blueprint run.
', 'StartJobRunRequest$JobRunId' => 'The ID of a previous JobRun
to retry.
The ID assigned to this job run.
', 'StartWorkflowRunResponse$RunId' => 'An Id for the new run.
', 'StopWorkflowRunRequest$RunId' => 'The ID of the workflow run to stop.
', 'Trigger$Id' => 'Reserved for future use.
', 'WorkflowRun$WorkflowRunId' => 'The ID of this workflow run.
', 'WorkflowRun$PreviousRunId' => 'The ID of the previous workflow run.
', 'WorkflowRunProperties$key' => NULL, ], ], 'IdempotentParameterMismatchException' => [ 'base' => 'The same unique identifier was associated with two different records.
', 'refs' => [], ], 'IdleTimeout' => [ 'base' => NULL, 'refs' => [ 'Session$IdleTimeout' => 'The number of minutes when idle before the session times out.
', ], ], 'IllegalBlueprintStateException' => [ 'base' => 'The blueprint is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'IllegalSessionStateException' => [ 'base' => 'The session is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'IllegalWorkflowStateException' => [ 'base' => 'The workflow is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'ImportCatalogToGlueRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportCatalogToGlueResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportLabelsTaskRunProperties' => [ 'base' => 'Specifies configuration properties for an importing labels task run.
', 'refs' => [ 'TaskRunProperties$ImportLabelsTaskRunProperties' => 'The configuration properties for an importing labels task run.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$LineNumber' => 'The line number of the node.
', 'DecimalNumber$Scale' => 'The scale that determines where the decimal point falls in the unscaled value.
', 'StorageDescriptor$NumberOfBuckets' => 'Must be specified if the table contains any dimension columns.
', ], ], 'IntegerFlag' => [ 'base' => NULL, 'refs' => [ 'Order$SortOrder' => 'Indicates that the column is sorted in ascending order (== 1
), or in descending order (==0
).
The ID of the statement to be cancelled.
', 'CreateDevEndpointRequest$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) to allocate to this DevEndpoint
.
The Apache Zeppelin port for the remote Apache Spark interpreter.
', 'CreateDevEndpointResponse$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
', 'CreateJobRequest$AllocatedCapacity' => 'This parameter is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'DevEndpoint$ZeppelinRemoteSparkInterpreterPort' => 'The Apache Zeppelin port for the remote Apache Spark interpreter.
', 'DevEndpoint$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint
.
The Id of the statement.
', 'Job$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'JobBookmarkEntry$Version' => 'The version of the job.
', 'JobBookmarkEntry$Run' => 'The run ID number.
', 'JobBookmarkEntry$Attempt' => 'The attempt ID number.
', 'JobRun$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'JobUpdate$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'RunStatementResponse$Id' => 'Returns the Id of the statement that was run.
', 'StartJobRunRequest$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'Statement$Id' => 'The ID of the statement.
', 'StatementOutput$ExecutionCount' => 'The execution count of the output.
', 'WorkflowRunStatistics$TotalActions' => 'Total number of Actions in the workflow run.
', 'WorkflowRunStatistics$TimeoutActions' => 'Total number of Actions that timed out.
', 'WorkflowRunStatistics$FailedActions' => 'Total number of Actions that have failed.
', 'WorkflowRunStatistics$StoppedActions' => 'Total number of Actions that have stopped.
', 'WorkflowRunStatistics$SucceededActions' => 'Total number of Actions that have succeeded.
', 'WorkflowRunStatistics$RunningActions' => 'Total number Actions in running state.
', 'WorkflowRunStatistics$ErroredActions' => 'Indicates the count of job runs in the ERROR state in the workflow run.
', 'WorkflowRunStatistics$WaitingActions' => 'Indicates the count of job runs in WAITING state in the workflow run.
', ], ], 'InternalServiceException' => [ 'base' => 'An internal service error occurred.
', 'refs' => [], ], 'InvalidInputException' => [ 'base' => 'The input provided was not valid.
', 'refs' => [], ], 'InvalidStateException' => [ 'base' => 'An error that indicates your data is in an invalid state.
', 'refs' => [], ], 'IsVersionValid' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityResponse$Valid' => 'Return true, if the schema is valid and false otherwise.
', ], ], 'Iso8601DateTime' => [ 'base' => NULL, 'refs' => [ 'KafkaStreamingSourceOptions$StartingTimestamp' => 'The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
Only one of StartingTimestamp
or StartingOffsets
must be set.
The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
The connection type of the JDBC source.
', ], ], 'JDBCConnectorOptions' => [ 'base' => 'Additional connection options for the connector.
', 'refs' => [ 'JDBCConnectorSource$AdditionalOptions' => 'Additional connection options for the connector.
', ], ], 'JDBCConnectorSource' => [ 'base' => 'Specifies a connector to a JDBC data source.
', 'refs' => [ 'CodeGenConfigurationNode$JDBCConnectorSource' => 'Specifies a connector to a JDBC data source.
', ], ], 'JDBCConnectorTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', 'refs' => [ 'CodeGenConfigurationNode$JDBCConnectorTarget' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', ], ], 'JDBCDataType' => [ 'base' => NULL, 'refs' => [ 'JDBCDataTypeMapping$key' => NULL, ], ], 'JDBCDataTypeMapping' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorOptions$DataTypeMapping' => 'Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC type FLOAT
into the Java String
type by calling the ResultSet.getString()
method of the driver, and uses it to build the Glue record. The ResultSet
object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
Specifies a JDBC data store to crawl.
', 'refs' => [ 'JdbcTargetList$member' => NULL, ], ], 'JdbcTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$JdbcTargets' => 'Specifies JDBC targets.
', ], ], 'Job' => [ 'base' => 'Specifies a job definition.
', 'refs' => [ 'GetJobResponse$Job' => 'The requested job definition.
', 'JobList$member' => NULL, ], ], 'JobBookmarkEntry' => [ 'base' => 'Defines a point that a job can resume processing.
', 'refs' => [ 'GetJobBookmarkResponse$JobBookmarkEntry' => 'A structure that defines a point that a job can resume processing.
', 'ResetJobBookmarkResponse$JobBookmarkEntry' => 'The reset bookmark entry.
', ], ], 'JobBookmarksEncryption' => [ 'base' => 'Specifies how job bookmark data should be encrypted.
', 'refs' => [ 'EncryptionConfiguration$JobBookmarksEncryption' => 'The encryption configuration for job bookmarks.
', ], ], 'JobBookmarksEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'JobBookmarksEncryption$JobBookmarksEncryptionMode' => 'The encryption mode to use for job bookmarks data.
', ], ], 'JobCommand' => [ 'base' => 'Specifies code that runs when a job is run.
', 'refs' => [ 'CreateJobRequest$Command' => 'The JobCommand
that runs this job.
The JobCommand
that runs this job.
The JobCommand
that runs this job (required).
A list of job definitions.
', 'GetJobsResponse$Jobs' => 'A list of job definitions.
', ], ], 'JobMode' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$JobMode' => 'A mode that describes how a job was created. Valid values are:
SCRIPT
- The job was created using the Glue Studio script editor.
VISUAL
- The job was created using the Glue Studio visual editor.
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
A mode that describes how a job was created. Valid values are:
SCRIPT
- The job was created using the Glue Studio script editor.
VISUAL
- The job was created using the Glue Studio visual editor.
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
A mode that describes how a job was created. Valid values are:
SCRIPT
- The job was created using the Glue Studio script editor.
VISUAL
- The job was created using the Glue Studio visual editor.
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
A mode that describes how a job was created. Valid values are:
SCRIPT
- The job was created using the Glue Studio script editor.
VISUAL
- The job was created using the Glue Studio visual editor.
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
The name of the job in question.
', 'JobBookmarkEntry$JobName' => 'The name of the job in question.
', 'ResetJobBookmarkRequest$JobName' => 'The name of the job in question.
', ], ], 'JobNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetJobsRequest$JobNames' => 'A list of job names, which might be the names returned from the ListJobs
operation.
A list of names of jobs not found.
', 'ListJobsResponse$JobNames' => 'The names of all jobs in the account, or the jobs with the specified tags.
', ], ], 'JobNodeDetails' => [ 'base' => 'The details of a Job node present in the workflow.
', 'refs' => [ 'Node$JobDetails' => 'Details of the Job when the node represents a Job.
', ], ], 'JobRun' => [ 'base' => 'Contains information about a job run.
', 'refs' => [ 'GetJobRunResponse$JobRun' => 'The requested job-run metadata.
', 'JobRunList$member' => NULL, ], ], 'JobRunList' => [ 'base' => NULL, 'refs' => [ 'GetJobRunsResponse$JobRuns' => 'A list of job-run metadata objects.
', 'JobNodeDetails$JobRuns' => 'The information for the job runs represented by the job node.
', ], ], 'JobRunState' => [ 'base' => NULL, 'refs' => [ 'Condition$State' => 'The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED
, STOPPED
, FAILED
, and TIMEOUT
. The only crawler states that a trigger can listen for are SUCCEEDED
, FAILED
, and CANCELLED
.
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
', ], ], 'JobUpdate' => [ 'base' => 'Specifies information used to update an existing job definition. The previous job definition is completely overwritten by this information.
', 'refs' => [ 'UpdateJobRequest$JobUpdate' => 'Specifies the values with which to update the job definition. Unspecified configuration is removed or reset to default values.
', ], ], 'Join' => [ 'base' => 'Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
', 'refs' => [ 'CodeGenConfigurationNode$Join' => 'Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
', ], ], 'JoinColumn' => [ 'base' => 'Specifies a column to be joined.
', 'refs' => [ 'JoinColumns$member' => NULL, ], ], 'JoinColumns' => [ 'base' => NULL, 'refs' => [ 'Join$Columns' => 'A list of the two columns to be joined.
', ], ], 'JoinType' => [ 'base' => NULL, 'refs' => [ 'Join$JoinType' => 'Specifies the type of join to be performed on the datasets.
', ], ], 'JsonClassifier' => [ 'base' => 'A classifier for JSON
content.
A classifier for JSON content.
', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'CreateJsonClassifierRequest$JsonPath' => 'A JsonPath
string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
A JsonPath
string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
A JsonPath
string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
The bookmark itself.
', ], ], 'KafkaStreamingSourceOptions' => [ 'base' => 'Additional options for streaming.
', 'refs' => [ 'CatalogKafkaSource$StreamingOptions' => 'Specifies the streaming options.
', 'DirectKafkaSource$StreamingOptions' => 'Specifies the streaming options.
', ], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'PartitionIndex$Keys' => 'The keys for the partition index.
', ], ], 'KeySchemaElement' => [ 'base' => 'A partition key pair consisting of a name and a type.
', 'refs' => [ 'KeySchemaElementList$member' => NULL, ], ], 'KeySchemaElementList' => [ 'base' => NULL, 'refs' => [ 'PartitionIndexDescriptor$Keys' => 'A list of one or more keys, as KeySchemaElement
structures, for the partition index.
Additional options for the Amazon Kinesis streaming data source.
', 'refs' => [ 'CatalogKinesisSource$StreamingOptions' => 'Additional options for the Kinesis streaming data source.
', 'DirectKinesisSource$StreamingOptions' => 'Additional options for the Kinesis streaming data source.
', ], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEncryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', 'JobBookmarksEncryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', 'S3Encryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', ], ], 'LabelCount' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformResponse$LabelCount' => 'The number of labels available for this transform.
', 'MLTransform$LabelCount' => 'A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
', ], ], 'LabelingSetGenerationTaskRunProperties' => [ 'base' => 'Specifies configuration properties for a labeling set generation task run.
', 'refs' => [ 'TaskRunProperties$LabelingSetGenerationTaskRunProperties' => 'The configuration properties for a labeling set generation task run.
', ], ], 'LakeFormationConfiguration' => [ 'base' => 'Specifies Lake Formation configuration settings for the crawler.
', 'refs' => [ 'Crawler$LakeFormationConfiguration' => 'Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
', 'CreateCrawlerRequest$LakeFormationConfiguration' => 'Specifies Lake Formation configuration settings for the crawler.
', 'UpdateCrawlerRequest$LakeFormationConfiguration' => 'Specifies Lake Formation configuration settings for the crawler.
', ], ], 'Language' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$Language' => 'The programming language of the resulting code from the DAG.
', 'GetPlanRequest$Language' => 'The programming language of the code to perform the mapping.
', ], ], 'LastActiveDefinition' => [ 'base' => 'When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
', 'refs' => [ 'Blueprint$LastActiveDefinition' => 'When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
', ], ], 'LastCrawlInfo' => [ 'base' => 'Status and error information about the most recent crawl.
', 'refs' => [ 'Crawler$LastCrawl' => 'The status of the last crawl, and potentially error information if an error occurred.
', ], ], 'LastCrawlStatus' => [ 'base' => NULL, 'refs' => [ 'LastCrawlInfo$Status' => 'Status of the last crawl.
', ], ], 'LatestSchemaVersionBoolean' => [ 'base' => NULL, 'refs' => [ 'PutSchemaVersionMetadataResponse$LatestVersion' => 'The latest version of the schema.
', 'RemoveSchemaVersionMetadataResponse$LatestVersion' => 'The latest version of the schema.
', 'SchemaVersionNumber$LatestVersion' => 'The latest version available for the schema.
', ], ], 'LimitedPathList' => [ 'base' => NULL, 'refs' => [ 'DropDuplicates$Columns' => 'The name of the columns to be merged or removed if repeating.
', ], ], 'LimitedStringList' => [ 'base' => NULL, 'refs' => [ 'LimitedPathList$member' => NULL, ], ], 'LineageConfiguration' => [ 'base' => 'Specifies data lineage configuration settings for the crawler.
', 'refs' => [ 'Crawler$LineageConfiguration' => 'A configuration that specifies whether data lineage is enabled for the crawler.
', 'CreateCrawlerRequest$LineageConfiguration' => 'Specifies data lineage configuration settings for the crawler.
', 'UpdateCrawlerRequest$LineageConfiguration' => 'Specifies data lineage configuration settings for the crawler.
', ], ], 'ListBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListColumnStatisticsTaskRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListColumnStatisticsTaskRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomEntityTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityResultsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityResultsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRuleRecommendationRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRuleRecommendationRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetEvaluationRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetEvaluationRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMLTransformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMLTransformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSessionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSessionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStatementsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStatementsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTableOptimizerRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTableOptimizerRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTableOptimizerRunsToken' => [ 'base' => NULL, 'refs' => [ 'ListTableOptimizerRunsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListTableOptimizerRunsResponse$NextToken' => 'A continuation token for paginating the returned list of optimizer runs, returned if the current segment of the list is not the last.
', ], ], 'ListTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsageProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsageProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => 'The location of resources.
', 'refs' => [ 'GetMappingRequest$Location' => 'Parameters for the mapping.
', 'GetPlanRequest$Location' => 'The parameters for the mapping.
', ], ], 'LocationMap' => [ 'base' => NULL, 'refs' => [ 'SkewedInfo$SkewedColumnValueLocationMaps' => 'A mapping of skewed values to the columns that contain them.
', ], ], 'LocationString' => [ 'base' => NULL, 'refs' => [ 'LocationStringList$member' => NULL, 'StorageDescriptor$Location' => 'The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
', ], ], 'LocationStringList' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$AdditionalLocations' => 'A list of locations that point to the path where a Delta table is located.
', ], ], 'LogGroup' => [ 'base' => NULL, 'refs' => [ 'Crawl$LogGroup' => 'The log group associated with the crawl.
', 'CrawlerHistory$LogGroup' => 'The log group associated with the crawl.
', 'LastCrawlInfo$LogGroup' => 'The log group for the last crawl.
', ], ], 'LogStream' => [ 'base' => NULL, 'refs' => [ 'Crawl$LogStream' => 'The log stream associated with the crawl.
', 'CrawlerHistory$LogStream' => 'The log stream associated with the crawl.
', 'LastCrawlInfo$LogStream' => 'The log stream for the last crawl.
', ], ], 'Logical' => [ 'base' => NULL, 'refs' => [ 'Predicate$Logical' => 'An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
', ], ], 'LogicalOperator' => [ 'base' => NULL, 'refs' => [ 'Condition$LogicalOperator' => 'A logical operator.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'LongColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'LongColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'LongColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for integer data columns.
', 'refs' => [ 'ColumnStatisticsData$LongColumnStatisticsData' => 'Long column statistics data.
', ], ], 'LongValue' => [ 'base' => NULL, 'refs' => [ 'Statement$StartedOn' => 'The unix time and date that the job definition was started.
', 'Statement$CompletedOn' => 'The unix time and date that the job definition was completed.
', ], ], 'LongValueString' => [ 'base' => NULL, 'refs' => [ 'Connection$StatusReason' => 'The reason for the connection status.
', ], ], 'MLTransform' => [ 'base' => 'A structure for a machine learning transform.
', 'refs' => [ 'TransformList$member' => NULL, ], ], 'MLTransformNotReadyException' => [ 'base' => 'The machine learning transform is not ready to run.
', 'refs' => [], ], 'MLUserDataEncryption' => [ 'base' => 'The encryption-at-rest settings of the transform that apply to accessing user data.
', 'refs' => [ 'TransformEncryption$MlUserDataEncryption' => 'An MLUserDataEncryption
object containing the encryption mode and customer-provided KMS key ID.
The encryption mode applied to user data. Valid values are:
DISABLED: encryption is disabled
SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
', 'Job$MaintenanceWindow' => 'This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
', 'JobRun$MaintenanceWindow' => 'This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
', 'JobUpdate$MaintenanceWindow' => 'This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
', ], ], 'ManyInputs' => [ 'base' => NULL, 'refs' => [ 'CustomCode$Inputs' => 'The data inputs identified by their node names.
', 'EvaluateDataQualityMultiFrame$Inputs' => 'The inputs of your data quality evaluation. The first input in this list is the primary data source.
', 'SparkSQL$Inputs' => 'The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
', ], ], 'MapValue' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$Arguments' => 'A map of arguments used to configure the DevEndpoint
.
The map of arguments used to configure this DevEndpoint
.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
A map of arguments used to configure the DevEndpoint
.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
The map of arguments to add the map of arguments used to configure the DevEndpoint
.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
Specifies the mapping of data property keys.
', 'refs' => [ 'Mappings$member' => NULL, ], ], 'MappingEntry' => [ 'base' => 'Defines a mapping.
', 'refs' => [ 'MappingList$member' => NULL, ], ], 'MappingList' => [ 'base' => NULL, 'refs' => [ 'GetMappingResponse$Mapping' => 'A list of mappings to the specified targets.
', 'GetPlanRequest$Mapping' => 'The list of mappings from a source table to target tables.
', ], ], 'Mappings' => [ 'base' => NULL, 'refs' => [ 'ApplyMapping$Mapping' => 'Specifies the mapping of data property keys in the data source to data property keys in the data target.
', 'Mapping$Children' => 'Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping
, but its FromPath
will be the parent\'s FromPath
plus the FromPath
from this structure.
For the children part, suppose you have the structure:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
You can specify a Mapping
that looks like:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
Indicates the value that will replace the detected entity.
', ], ], 'MatchCriteria' => [ 'base' => NULL, 'refs' => [ 'Connection$MatchCriteria' => 'A list of criteria that can be used in selecting this connection.
', 'ConnectionInput$MatchCriteria' => 'A list of criteria that can be used in selecting this connection.
', 'GetConnectionsFilter$MatchCriteria' => 'A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
', ], ], 'MaxConcurrentRuns' => [ 'base' => NULL, 'refs' => [ 'ExecutionProperty$MaxConcurrentRuns' => 'The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
', ], ], 'MaxListTableOptimizerRunsTokenResults' => [ 'base' => NULL, 'refs' => [ 'ListTableOptimizerRunsRequest$MaxResults' => 'The maximum number of optimizer runs to return on each call.
', ], ], 'MaxResultsNumber' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', 'ListSchemaVersionsInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', 'ListSchemasInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', ], ], 'MaxRetries' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$MaxRetries' => 'The maximum number of times to retry this job if it fails.
', 'Job$MaxRetries' => 'The maximum number of times to retry this job after a JobRun fails.
', 'JobUpdate$MaxRetries' => 'The maximum number of times to retry this job if it fails.
', ], ], 'Merge' => [ 'base' => 'Specifies a transform that merges a DynamicFrame
with a staging DynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
Specifies a transform that merges a DynamicFrame
with a staging DynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
The prefix for a CloudWatch message about this crawl.
', 'LastCrawlInfo$MessagePrefix' => 'The prefix for a message about this crawl.
', ], ], 'MessageString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => 'A message describing the problem.
', 'AlreadyExistsException$Message' => 'A message describing the problem.
', 'BlueprintRun$ErrorMessage' => 'Indicates any errors that are seen while running the blueprint.
', 'BlueprintRun$RollbackErrorMessage' => 'If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
', 'ColumnStatisticsTaskNotRunningException$Message' => 'A message describing the problem.
', 'ColumnStatisticsTaskRunningException$Message' => 'A message describing the problem.
', 'ColumnStatisticsTaskStoppingException$Message' => 'A message describing the problem.
', 'ConcurrentModificationException$Message' => 'A message describing the problem.
', 'ConcurrentRunsExceededException$Message' => 'A message describing the problem.
', 'ConditionCheckFailureException$Message' => 'A message describing the problem.
', 'ConflictException$Message' => 'A message describing the problem.
', 'CrawlerNotRunningException$Message' => 'A message describing the problem.
', 'CrawlerRunningException$Message' => 'A message describing the problem.
', 'CrawlerStoppingException$Message' => 'A message describing the problem.
', 'EntityNotFoundException$Message' => 'A message describing the problem.
', 'FederatedResourceAlreadyExistsException$Message' => 'The message describing the problem.
', 'FederationSourceException$Message' => 'The message describing the problem.
', 'FederationSourceRetryableException$Message' => 'A message describing the problem.
', 'GlueEncryptionException$Message' => 'The message describing the problem.
', 'IdempotentParameterMismatchException$Message' => 'A message describing the problem.
', 'IllegalBlueprintStateException$Message' => 'A message describing the problem.
', 'IllegalSessionStateException$Message' => 'A message describing the problem.
', 'IllegalWorkflowStateException$Message' => 'A message describing the problem.
', 'InternalServiceException$Message' => 'A message describing the problem.
', 'InvalidInputException$Message' => 'A message describing the problem.
', 'InvalidStateException$Message' => 'A message describing the problem.
', 'MLTransformNotReadyException$Message' => 'A message describing the problem.
', 'NoScheduleException$Message' => 'A message describing the problem.
', 'OperationNotSupportedException$Message' => 'A message describing the problem.
', 'OperationTimeoutException$Message' => 'A message describing the problem.
', 'PermissionTypeMismatchException$Message' => 'There is a mismatch between the SupportedPermissionType used in the query request and the permissions defined on the target table.
', 'ResourceNotReadyException$Message' => 'A message describing the problem.
', 'ResourceNumberLimitExceededException$Message' => 'A message describing the problem.
', 'RunMetrics$NumberOfBytesCompacted' => 'The number of bytes removed by the compaction job run.
', 'RunMetrics$NumberOfFilesCompacted' => 'The number of files removed by the compaction job run.
', 'RunMetrics$NumberOfDpus' => 'The number of DPU hours consumed by the job.
', 'RunMetrics$JobDurationInHour' => 'The duration of the job in hours.
', 'SchedulerNotRunningException$Message' => 'A message describing the problem.
', 'SchedulerRunningException$Message' => 'A message describing the problem.
', 'SchedulerTransitioningException$Message' => 'A message describing the problem.
', 'TableOptimizerRun$error' => 'An error that occured during the optimizer run.
', 'ValidationException$Message' => 'A message describing the problem.
', 'VersionMismatchException$Message' => 'A message describing the problem.
', ], ], 'MetadataInfo' => [ 'base' => 'A structure containing metadata information for a schema version.
', 'refs' => [ 'MetadataInfoMap$value' => NULL, ], ], 'MetadataInfoMap' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataResponse$MetadataInfoMap' => 'A map of a metadata key and associated values.
', ], ], 'MetadataKeyString' => [ 'base' => NULL, 'refs' => [ 'MetadataInfoMap$key' => NULL, 'MetadataKeyValuePair$MetadataKey' => 'A metadata key.
', 'PutSchemaVersionMetadataResponse$MetadataKey' => 'The metadata key.
', 'RemoveSchemaVersionMetadataResponse$MetadataKey' => 'The metadata key.
', ], ], 'MetadataKeyValuePair' => [ 'base' => 'A structure containing a key value pair for metadata.
', 'refs' => [ 'MetadataList$member' => NULL, 'PutSchemaVersionMetadataInput$MetadataKeyValue' => 'The metadata key\'s corresponding value.
', 'RemoveSchemaVersionMetadataInput$MetadataKeyValue' => 'The value of the metadata key.
', ], ], 'MetadataList' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataInput$MetadataList' => 'Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
', ], ], 'MetadataOperation' => [ 'base' => NULL, 'refs' => [ 'IcebergInput$MetadataOperation' => 'A required metadata operation. Can only be set to CREATE
.
The metadata key’s corresponding value.
', 'MetadataKeyValuePair$MetadataValue' => 'A metadata key’s corresponding value.
', 'OtherMetadataValueListItem$MetadataValue' => 'The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
', 'PutSchemaVersionMetadataResponse$MetadataValue' => 'The value of the metadata key.
', 'RemoveSchemaVersionMetadataResponse$MetadataValue' => 'The value of the metadata key.
', ], ], 'MetricBasedObservation' => [ 'base' => 'Describes the metric based observation generated based on evaluated data quality metrics.
', 'refs' => [ 'DataQualityObservation$MetricBasedObservation' => 'An object of type MetricBasedObservation
representing the observation that is based on evaluated data quality metrics.
Specifies a Microsoft SQL server data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$MicrosoftSQLServerCatalogSource' => 'Specifies a Microsoft SQL server data source in the Glue Data Catalog.
', ], ], 'MicrosoftSQLServerCatalogTarget' => [ 'base' => 'Specifies a target that uses Microsoft SQL.
', 'refs' => [ 'CodeGenConfigurationNode$MicrosoftSQLServerCatalogTarget' => 'Specifies a target that uses Microsoft SQL.
', ], ], 'MillisecondsCount' => [ 'base' => NULL, 'refs' => [ 'Crawler$CrawlElapsedTime' => 'If the crawler is running, contains the total time elapsed since the last crawl began.
', ], ], 'MongoDBTarget' => [ 'base' => 'Specifies an Amazon DocumentDB or MongoDB data store to crawl.
', 'refs' => [ 'MongoDBTargetList$member' => NULL, ], ], 'MongoDBTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$MongoDBTargets' => 'Specifies Amazon DocumentDB or MongoDB targets.
', ], ], 'MySQLCatalogSource' => [ 'base' => 'Specifies a MySQL data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$MySQLCatalogSource' => 'Specifies a MySQL data source in the Glue Data Catalog.
', ], ], 'MySQLCatalogTarget' => [ 'base' => 'Specifies a target that uses MySQL.
', 'refs' => [ 'CodeGenConfigurationNode$MySQLCatalogTarget' => 'Specifies a target that uses MySQL.
', ], ], 'NameString' => [ 'base' => NULL, 'refs' => [ 'Action$JobName' => 'The name of a job to be run.
', 'Action$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this action.
The name of the crawler to be used with this action.
', 'BatchCreatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be created.
', 'BatchCreatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be created.
', 'BatchDeletePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'BatchDeletePartitionRequest$TableName' => 'The name of the table that contains the partitions to be deleted.
', 'BatchDeleteTableNameList$member' => NULL, 'BatchDeleteTableRequest$DatabaseName' => 'The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.
', 'BatchDeleteTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'BatchDeleteTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'BatchGetPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'BatchGetPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'BatchStopJobRunError$JobName' => 'The name of the job definition that is used in the job run in question.
', 'BatchStopJobRunRequest$JobName' => 'The name of the job definition for which to stop job runs.
', 'BatchStopJobRunSuccessfulSubmission$JobName' => 'The name of the job definition used in the job run that was stopped.
', 'BatchUpdatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be updated.
', 'BatchUpdatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be updated.
', 'BlueprintRun$WorkflowName' => 'The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
', 'CancelStatementRequest$SessionId' => 'The Session ID of the statement to be cancelled.
', 'CatalogEntry$DatabaseName' => 'The database in which the table metadata resides.
', 'CatalogEntry$TableName' => 'The name of the table in question.
', 'CatalogImportStatus$ImportedBy' => 'The name of the person who initiated the migration.
', 'CatalogTablesList$member' => NULL, 'CatalogTarget$DatabaseName' => 'The name of the database to be synchronized.
', 'ClassifierNameList$member' => NULL, 'Column$Name' => 'The name of the Column
.
The name of the column that failed.
', 'ColumnImportance$ColumnName' => 'The name of a column.
', 'ColumnNameList$member' => NULL, 'ColumnRowFilter$ColumnName' => 'A string containing the name of the column.
', 'ColumnStatistics$ColumnName' => 'Name of column which statistics belong to.
', 'ColumnStatisticsTaskRun$WorkerType' => 'The type of workers being used for generating stats. The default is g.1x
.
The name of the job whose JobRuns
this condition applies to, and on which this trigger waits.
The name of the crawler to which this condition applies.
', 'ConfigurationMap$key' => NULL, 'Connection$Name' => 'The name of the connection definition.
', 'Connection$LastUpdatedBy' => 'The user, group, or role that last updated this connection definition.
', 'ConnectionInput$Name' => 'The name of the connection.
', 'ConnectionPasswordEncryption$AwsKmsKeyId' => 'An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of CreateConnection
and UpdateConnection
needs at least kms:Encrypt
permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
', 'ContextWords$member' => NULL, 'Crawler$Name' => 'The name of the crawler.
', 'CrawlerHistory$Summary' => 'A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.
', 'CrawlerMetrics$CrawlerName' => 'The name of the crawler.
', 'CrawlerNameList$member' => NULL, 'CreateBlueprintResponse$Name' => 'Returns the name of the blueprint that was registered.
', 'CreateCrawlerRequest$Name' => 'Name of the new crawler.
', 'CreateCsvClassifierRequest$Name' => 'The name of the classifier.
', 'CreateCustomEntityTypeRequest$Name' => 'A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
', 'CreateCustomEntityTypeRequest$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'CreateCustomEntityTypeResponse$Name' => 'The name of the custom pattern you created.
', 'CreateDataQualityRulesetRequest$Name' => 'A unique name for the data quality ruleset.
', 'CreateDataQualityRulesetResponse$Name' => 'A unique name for the data quality ruleset.
', 'CreateDevEndpointRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this DevEndpoint
.
The name of the SecurityConfiguration
structure being used with this DevEndpoint
.
The name of the new classifier.
', 'CreateJobRequest$Name' => 'The name you assign to this job definition. It must be unique in your account.
', 'CreateJobRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job.
The unique name that was provided for this job definition.
', 'CreateJsonClassifierRequest$Name' => 'The name of the classifier.
', 'CreateMLTransformRequest$Name' => 'The unique name that you give the transform when you create it.
', 'CreatePartitionIndexRequest$DatabaseName' => 'Specifies the name of a database in which you want to create a partition index.
', 'CreatePartitionIndexRequest$TableName' => 'Specifies the name of a table in which you want to create a partition index.
', 'CreatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be created.
', 'CreatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be created.
', 'CreateSecurityConfigurationRequest$Name' => 'The name for the new security configuration.
', 'CreateSecurityConfigurationResponse$Name' => 'The name assigned to the new security configuration.
', 'CreateSessionRequest$Id' => 'The ID of the session request.
', 'CreateSessionRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with the session
', 'CreateTableOptimizerRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'CreateTableOptimizerRequest$TableName' => 'The name of the table.
', 'CreateTableRequest$DatabaseName' => 'The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
', 'CreateTriggerRequest$Name' => 'The name of the trigger.
', 'CreateTriggerRequest$WorkflowName' => 'The name of the workflow associated with the trigger.
', 'CreateTriggerResponse$Name' => 'The name of the trigger.
', 'CreateUsageProfileRequest$Name' => 'The name of the usage profile.
', 'CreateUsageProfileResponse$Name' => 'The name of the usage profile that was created.
', 'CreateUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database in which to create the function.
', 'CreateWorkflowRequest$Name' => 'The name to be assigned to the workflow. It should be unique within your account.
', 'CreateWorkflowResponse$Name' => 'The name of the workflow which was provided as part of the request.
', 'CreateXMLClassifierRequest$Name' => 'The name of the classifier.
', 'CsvClassifier$Name' => 'The name of the classifier.
', 'CsvHeader$member' => NULL, 'CustomDatatypes$member' => NULL, 'CustomEntityType$Name' => 'A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
', 'CustomEntityType$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'CustomEntityTypeNames$member' => NULL, 'DataQualityAnalyzerResult$Name' => 'The name of the data quality analyzer.
', 'DataQualityResult$RulesetName' => 'The name of the ruleset associated with the data quality result.
', 'DataQualityResult$JobName' => 'The job name associated with the data quality result, if any.
', 'DataQualityResultDescription$JobName' => 'The job name associated with the data quality result.
', 'DataQualityResultFilterCriteria$JobName' => 'Filter results by the specified job name.
', 'DataQualityRuleResult$Name' => 'The name of the data quality rule.
', 'DataQualityRulesetFilterCriteria$Name' => 'The name of the ruleset filter criteria.
', 'DataQualityRulesetListDetails$Name' => 'The name of the data quality ruleset.
', 'DataQualityTargetTable$TableName' => 'The name of the Glue table.
', 'DataQualityTargetTable$DatabaseName' => 'The name of the database where the Glue table exists.
', 'DataQualityTargetTable$CatalogId' => 'The catalog id where the Glue table exists.
', 'DataSourceMap$key' => NULL, 'Database$Name' => 'The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
', 'DatabaseIdentifier$DatabaseName' => 'The name of the catalog database.
', 'DatabaseIdentifier$Region' => 'Region of the target database.
', 'DatabaseInput$Name' => 'The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
', 'DeleteBlueprintRequest$Name' => 'The name of the blueprint to delete.
', 'DeleteBlueprintResponse$Name' => 'Returns the name of the blueprint that was deleted.
', 'DeleteClassifierRequest$Name' => 'Name of the classifier to remove.
', 'DeleteColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'DeleteColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'DeleteColumnStatisticsForPartitionRequest$ColumnName' => 'Name of the column.
', 'DeleteColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'DeleteColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'DeleteColumnStatisticsForTableRequest$ColumnName' => 'The name of the column.
', 'DeleteConnectionNameList$member' => NULL, 'DeleteConnectionRequest$ConnectionName' => 'The name of the connection to delete.
', 'DeleteCrawlerRequest$Name' => 'The name of the crawler to remove.
', 'DeleteCustomEntityTypeRequest$Name' => 'The name of the custom pattern that you want to delete.
', 'DeleteCustomEntityTypeResponse$Name' => 'The name of the custom pattern you deleted.
', 'DeleteDataQualityRulesetRequest$Name' => 'A name for the data quality ruleset.
', 'DeleteDatabaseRequest$Name' => 'The name of the database to delete. For Hive compatibility, this must be all lowercase.
', 'DeleteJobRequest$JobName' => 'The name of the job definition to delete.
', 'DeleteJobResponse$JobName' => 'The name of the job definition that was deleted.
', 'DeletePartitionIndexRequest$DatabaseName' => 'Specifies the name of a database from which you want to delete a partition index.
', 'DeletePartitionIndexRequest$TableName' => 'Specifies the name of a table from which you want to delete a partition index.
', 'DeletePartitionIndexRequest$IndexName' => 'The name of the partition index to be deleted.
', 'DeletePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'DeletePartitionRequest$TableName' => 'The name of the table that contains the partition to be deleted.
', 'DeleteSecurityConfigurationRequest$Name' => 'The name of the security configuration to delete.
', 'DeleteSessionRequest$Id' => 'The ID of the session to be deleted.
', 'DeleteSessionResponse$Id' => 'Returns the ID of the deleted session.
', 'DeleteTableOptimizerRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'DeleteTableOptimizerRequest$TableName' => 'The name of the table.
', 'DeleteTableRequest$DatabaseName' => 'The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableRequest$Name' => 'The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTriggerRequest$Name' => 'The name of the trigger to delete.
', 'DeleteTriggerResponse$Name' => 'The name of the trigger that was deleted.
', 'DeleteUsageProfileRequest$Name' => 'The name of the usage profile to delete.
', 'DeleteUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function is located.
', 'DeleteUserDefinedFunctionRequest$FunctionName' => 'The name of the function definition to be deleted.
', 'DeleteWorkflowRequest$Name' => 'Name of the workflow to be deleted.
', 'DeleteWorkflowResponse$Name' => 'Name of the workflow specified in input.
', 'DevEndpoint$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this DevEndpoint
.
The unique of the node within the workflow where the edge starts.
', 'Edge$DestinationId' => 'The unique of the node within the workflow where the edge ends.
', 'EncryptionAtRest$SseAwsKmsKeyId' => 'The ID of the KMS key to use for encryption at rest.
', 'ErrorByName$key' => NULL, 'ErrorDetail$ErrorCode' => 'The code associated with this error.
', 'EvaluatedMetricsMap$key' => NULL, 'FederatedDatabase$ConnectionName' => 'The name of the connection to the external metastore.
', 'FederatedTable$ConnectionName' => 'The name of the connection to the external metastore.
', 'FindMatchesTaskRunProperties$JobName' => 'The name assigned to the job for the Find Matches task run.
', 'GetBlueprintRequest$Name' => 'The name of the blueprint.
', 'GetBlueprintRunsRequest$BlueprintName' => 'The name of the blueprint.
', 'GetClassifierRequest$Name' => 'Name of the classifier to retrieve.
', 'GetColumnNamesList$member' => NULL, 'GetColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'GetColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'GetColumnStatisticsTaskRunsRequest$TableName' => 'The name of the table.
', 'GetConnectionRequest$Name' => 'The name of the connection definition to retrieve.
', 'GetCrawlerRequest$Name' => 'The name of the crawler to retrieve metadata for.
', 'GetCustomEntityTypeRequest$Name' => 'The name of the custom pattern that you want to retrieve.
', 'GetCustomEntityTypeResponse$Name' => 'The name of the custom pattern that you retrieved.
', 'GetCustomEntityTypeResponse$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'GetDataQualityResultResponse$RulesetName' => 'The name of the ruleset associated with the data quality result.
', 'GetDataQualityResultResponse$JobName' => 'The job name associated with the data quality result, if any.
', 'GetDataQualityRuleRecommendationRunResponse$CreatedRulesetName' => 'The name of the ruleset that was created by the run.
', 'GetDataQualityRulesetRequest$Name' => 'The name of the ruleset.
', 'GetDataQualityRulesetResponse$Name' => 'The name of the ruleset.
', 'GetDatabaseRequest$Name' => 'The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
', 'GetJobRequest$JobName' => 'The name of the job definition to retrieve.
', 'GetJobRunRequest$JobName' => 'Name of the job definition being run.
', 'GetJobRunsRequest$JobName' => 'The name of the job definition for which to retrieve all job runs.
', 'GetMLTransformResponse$Name' => 'The unique name given to the transform when it was created.
', 'GetPartitionIndexesRequest$DatabaseName' => 'Specifies the name of a database from which you want to retrieve partition indexes.
', 'GetPartitionIndexesRequest$TableName' => 'Specifies the name of a table for which you want to retrieve the partition indexes.
', 'GetPartitionRequest$DatabaseName' => 'The name of the catalog database where the partition resides.
', 'GetPartitionRequest$TableName' => 'The name of the partition\'s table.
', 'GetPartitionsRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetPartitionsRequest$TableName' => 'The name of the partitions\' table.
', 'GetSecurityConfigurationRequest$Name' => 'The name of the security configuration to retrieve.
', 'GetSessionRequest$Id' => 'The ID of the session.
', 'GetStatementRequest$SessionId' => 'The Session ID of the statement.
', 'GetTableOptimizerRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'GetTableOptimizerRequest$TableName' => 'The name of the table.
', 'GetTableOptimizerResponse$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'GetTableOptimizerResponse$TableName' => 'The name of the table.
', 'GetTableRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableRequest$Name' => 'The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionsRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionsRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'GetTablesRequest$DatabaseName' => 'The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
', 'GetTriggerRequest$Name' => 'The name of the trigger to retrieve.
', 'GetTriggersRequest$DependentJobName' => 'The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.
', 'GetUnfilteredPartitionMetadataRequest$DatabaseName' => '(Required) Specifies the name of a database that contains the partition.
', 'GetUnfilteredPartitionMetadataRequest$TableName' => '(Required) Specifies the name of a table that contains the partition.
', 'GetUnfilteredPartitionsMetadataRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetUnfilteredPartitionsMetadataRequest$TableName' => 'The name of the table that contains the partition.
', 'GetUnfilteredTableMetadataRequest$DatabaseName' => '(Required) Specifies the name of a database that contains the table.
', 'GetUnfilteredTableMetadataRequest$Name' => '(Required) Specifies the name of a table for which you are requesting metadata.
', 'GetUsageProfileRequest$Name' => 'The name of the usage profile to retrieve.
', 'GetUsageProfileResponse$Name' => 'The name of the usage profile.
', 'GetUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function is located.
', 'GetUserDefinedFunctionRequest$FunctionName' => 'The name of the function.
', 'GetUserDefinedFunctionsRequest$DatabaseName' => 'The name of the catalog database where the functions are located. If none is provided, functions from all the databases across the catalog will be returned.
', 'GetUserDefinedFunctionsRequest$Pattern' => 'An optional function-name pattern string that filters the function definitions returned.
', 'GetWorkflowRequest$Name' => 'The name of the workflow to retrieve.
', 'GetWorkflowRunPropertiesRequest$Name' => 'Name of the workflow which was run.
', 'GetWorkflowRunRequest$Name' => 'Name of the workflow being run.
', 'GetWorkflowRunsRequest$Name' => 'Name of the workflow whose metadata of runs should be returned.
', 'GlueTable$DatabaseName' => 'A database name in the Glue Data Catalog.
', 'GlueTable$TableName' => 'A table name in the Glue Data Catalog.
', 'GlueTable$CatalogId' => 'A unique identifier for the Glue Data Catalog.
', 'GlueTable$ConnectionName' => 'The name of the connection to the Glue Data Catalog.
', 'GlueTableAdditionalOptions$key' => NULL, 'GrokClassifier$Name' => 'The name of the classifier.
', 'Job$Name' => 'The name you assign to this job definition.
', 'Job$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job.
The name of an Glue usage profile associated with the job.
', 'JobNameList$member' => NULL, 'JobRun$TriggerName' => 'The name of the trigger that started this job run.
', 'JobRun$JobName' => 'The name of the job definition being used in this run.
', 'JobRun$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job run.
The name of an Glue usage profile associated with the job run.
', 'JobUpdate$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job.
The name of the classifier.
', 'KeyList$member' => NULL, 'KeySchemaElement$Name' => 'The name of a partition key.
', 'ListCrawlsRequest$CrawlerName' => 'The name of the crawler whose runs you want to retrieve.
', 'ListStatementsRequest$SessionId' => 'The Session ID of the statements.
', 'ListTableOptimizerRunsRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'ListTableOptimizerRunsRequest$TableName' => 'The name of the table.
', 'ListTableOptimizerRunsResponse$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'ListTableOptimizerRunsResponse$TableName' => 'The name of the table.
', 'ListTriggersRequest$DependentJobName' => 'The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.
', 'MLTransform$Name' => 'A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
', 'MLUserDataEncryption$KmsKeyId' => 'The ID for the customer-provided KMS key.
', 'MatchCriteria$member' => NULL, 'MetricBasedObservation$MetricName' => 'The name of the data quality metric used for generating the observation.
', 'NameStringList$member' => NULL, 'NewRules$member' => NULL, 'Node$Name' => 'The name of the Glue component represented by the node.
', 'Node$UniqueId' => 'The unique Id assigned to the node within the workflow.
', 'NodeIdList$member' => NULL, 'Order$Column' => 'The name of the column.
', 'Partition$DatabaseName' => 'The name of the catalog database in which to create the partition.
', 'Partition$TableName' => 'The name of the database table in which to create the partition.
', 'PartitionIndex$IndexName' => 'The name of the partition index.
', 'PartitionIndexDescriptor$IndexName' => 'The name of the partition index.
', 'PhysicalConnectionRequirements$SubnetId' => 'The subnet ID used by the connection.
', 'PhysicalConnectionRequirements$AvailabilityZone' => 'The connection\'s Availability Zone.
', 'Predecessor$JobName' => 'The name of the job definition used by the predecessor job run.
', 'PutWorkflowRunPropertiesRequest$Name' => 'Name of the workflow which was run.
', 'ResumeWorkflowRunRequest$Name' => 'The name of the workflow to resume.
', 'RulesetNames$member' => NULL, 'RunStatementRequest$SessionId' => 'The Session Id of the statement to be run.
', 'SecurityConfiguration$Name' => 'The name of the security configuration.
', 'SecurityGroupIdList$member' => NULL, 'SerDeInfo$Name' => 'Name of the SerDe.
', 'SerDeInfo$SerializationLibrary' => 'Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe
.
The ID of the session.
', 'Session$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with the session.
', 'Session$ProfileName' => 'The name of an Glue usage profile associated with the session.
', 'SessionCommand$Name' => 'Specifies the name of the SessionCommand. Can be \'glueetl\' or \'gluestreaming\'.
', 'SessionIdList$member' => NULL, 'StartColumnStatisticsTaskRunRequest$DatabaseName' => 'The name of the database where the table resides.
', 'StartColumnStatisticsTaskRunRequest$TableName' => 'The name of the table to generate statistics.
', 'StartColumnStatisticsTaskRunRequest$Role' => 'The IAM role that the service assumes to generate statistics.
', 'StartColumnStatisticsTaskRunRequest$CatalogID' => 'The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'StartColumnStatisticsTaskRunRequest$SecurityConfiguration' => 'Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
', 'StartCrawlerRequest$Name' => 'Name of the crawler to start.
', 'StartCrawlerScheduleRequest$CrawlerName' => 'Name of the crawler to schedule.
', 'StartDataQualityRuleRecommendationRunRequest$CreatedRulesetName' => 'A name for the ruleset.
', 'StartJobRunRequest$JobName' => 'The name of the job definition to use.
', 'StartJobRunRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job run.
The name of the trigger to start.
', 'StartTriggerResponse$Name' => 'The name of the trigger that was started.
', 'StartWorkflowRunRequest$Name' => 'The name of the workflow to start.
', 'StopColumnStatisticsTaskRunRequest$TableName' => 'The name of the table.
', 'StopCrawlerRequest$Name' => 'Name of the crawler to stop.
', 'StopCrawlerScheduleRequest$CrawlerName' => 'Name of the crawler whose schedule state to set.
', 'StopSessionRequest$Id' => 'The ID of the session to be stopped.
', 'StopSessionResponse$Id' => 'Returns the Id of the stopped session.
', 'StopTriggerRequest$Name' => 'The name of the trigger to stop.
', 'StopTriggerResponse$Name' => 'The name of the trigger that was stopped.
', 'StopWorkflowRunRequest$Name' => 'The name of the workflow to stop.
', 'Table$Name' => 'The table name. For Hive compatibility, this must be entirely lowercase.
', 'Table$DatabaseName' => 'The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
', 'Table$Owner' => 'The owner of the table.
', 'Table$CreatedBy' => 'The person or entity who created the table.
', 'TableError$TableName' => 'The name of the table. For Hive compatibility, this must be entirely lowercase.
', 'TableIdentifier$DatabaseName' => 'The name of the catalog database that contains the target table.
', 'TableIdentifier$Name' => 'The name of the target table.
', 'TableIdentifier$Region' => 'Region of the target table.
', 'TableInput$Name' => 'The table name. For Hive compatibility, this is folded to lowercase when it is stored.
', 'TableInput$Owner' => 'The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'TableVersionError$TableName' => 'The name of the table in question.
', 'TransformEncryption$TaskRunSecurityConfigurationName' => 'The name of the security configuration.
', 'TransformFilterCriteria$Name' => 'A unique transform name that is used to filter the machine learning transforms.
', 'Trigger$Name' => 'The name of the trigger.
', 'Trigger$WorkflowName' => 'The name of the workflow associated with the trigger.
', 'TriggerNameList$member' => NULL, 'TriggerUpdate$Name' => 'Reserved for future use.
', 'UpdateBlueprintResponse$Name' => 'Returns the name of the blueprint that was updated.
', 'UpdateColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'UpdateColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'UpdateColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'UpdateColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'UpdateConnectionRequest$Name' => 'The name of the connection definition to update.
', 'UpdateCrawlerRequest$Name' => 'Name of the new crawler.
', 'UpdateCrawlerScheduleRequest$CrawlerName' => 'The name of the crawler whose schedule to update.
', 'UpdateCsvClassifierRequest$Name' => 'The name of the classifier.
', 'UpdateDataQualityRulesetRequest$Name' => 'The name of the data quality ruleset.
', 'UpdateDataQualityRulesetResponse$Name' => 'The name of the data quality ruleset.
', 'UpdateDatabaseRequest$Name' => 'The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
', 'UpdateGrokClassifierRequest$Name' => 'The name of the GrokClassifier
.
The name of the Glue job to be synchronized to or from the remote repository.
', 'UpdateJobFromSourceControlRequest$RepositoryName' => 'The name of the remote repository that contains the job artifacts. For BitBucket providers, RepositoryName
should include WorkspaceName
. Use the format <WorkspaceName>/<RepositoryName>
.
The owner of the remote repository that contains the job artifacts.
', 'UpdateJobFromSourceControlRequest$BranchName' => 'An optional branch in the remote repository.
', 'UpdateJobFromSourceControlRequest$Folder' => 'An optional folder in the remote repository.
', 'UpdateJobFromSourceControlResponse$JobName' => 'The name of the Glue job.
', 'UpdateJobRequest$JobName' => 'The name of the job definition to update.
', 'UpdateJobResponse$JobName' => 'Returns the name of the updated job definition.
', 'UpdateJsonClassifierRequest$Name' => 'The name of the classifier.
', 'UpdateMLTransformRequest$Name' => 'The unique name that you gave the transform when you created it.
', 'UpdatePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'UpdatePartitionRequest$TableName' => 'The name of the table in which the partition to be updated is located.
', 'UpdateSourceControlFromJobRequest$JobName' => 'The name of the Glue job to be synchronized to or from the remote repository.
', 'UpdateSourceControlFromJobRequest$RepositoryName' => 'The name of the remote repository that contains the job artifacts. For BitBucket providers, RepositoryName
should include WorkspaceName
. Use the format <WorkspaceName>/<RepositoryName>
.
The owner of the remote repository that contains the job artifacts.
', 'UpdateSourceControlFromJobRequest$BranchName' => 'An optional branch in the remote repository.
', 'UpdateSourceControlFromJobRequest$Folder' => 'An optional folder in the remote repository.
', 'UpdateSourceControlFromJobResponse$JobName' => 'The name of the Glue job.
', 'UpdateTableOptimizerRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'UpdateTableOptimizerRequest$TableName' => 'The name of the table.
', 'UpdateTableRequest$DatabaseName' => 'The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'UpdateTriggerRequest$Name' => 'The name of the trigger to update.
', 'UpdateUsageProfileRequest$Name' => 'The name of the usage profile.
', 'UpdateUsageProfileResponse$Name' => 'The name of the usage profile that was updated.
', 'UpdateUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function to be updated is located.
', 'UpdateUserDefinedFunctionRequest$FunctionName' => 'The name of the function.
', 'UpdateWorkflowRequest$Name' => 'Name of the workflow to be updated.
', 'UpdateWorkflowResponse$Name' => 'The name of the workflow which was specified in input.
', 'UpdateXMLClassifierRequest$Name' => 'The name of the classifier.
', 'UsageProfileDefinition$Name' => 'The name of the usage profile.
', 'UserDefinedFunction$FunctionName' => 'The name of the function.
', 'UserDefinedFunction$DatabaseName' => 'The name of the catalog database that contains the function.
', 'UserDefinedFunction$ClassName' => 'The Java class that contains the function code.
', 'UserDefinedFunction$OwnerName' => 'The owner of the function.
', 'UserDefinedFunctionInput$FunctionName' => 'The name of the function.
', 'UserDefinedFunctionInput$ClassName' => 'The Java class that contains the function code.
', 'UserDefinedFunctionInput$OwnerName' => 'The owner of the function.
', 'ViewRepresentation$ValidationConnection' => 'The name of the connection to be used to validate the specific representation of the view.
', 'ViewRepresentationInput$ValidationConnection' => 'The name of the connection to be used to validate the specific representation of the view.
', 'Workflow$Name' => 'The name of the workflow.
', 'WorkflowNames$member' => NULL, 'WorkflowRun$Name' => 'Name of the workflow that was run.
', 'XMLClassifier$Name' => 'The name of the classifier.
', ], ], 'NameStringList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionResponse$Succeeded' => 'A list of names of the connection definitions that were successfully deleted.
', 'GetUnfilteredPartitionMetadataResponse$AuthorizedColumns' => 'A list of column names that the user has been granted access to.
', 'GetUnfilteredTableMetadataResponse$AuthorizedColumns' => 'A list of column names that the user has been granted access to.
', 'SkewedInfo$SkewedColumnNames' => 'A list of names of columns that contain skewed values.
', 'StorageDescriptor$BucketColumns' => 'A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
', 'UnfilteredPartition$AuthorizedColumns' => 'The list of columns the user has permissions to access.
', ], ], 'NewRules' => [ 'base' => NULL, 'refs' => [ 'MetricBasedObservation$NewRules' => 'A list of new data quality rules generated as part of the observation based on the data quality metric value.
', ], ], 'NoScheduleException' => [ 'base' => 'There is no applicable schedule.
', 'refs' => [], ], 'Node' => [ 'base' => 'A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
', 'refs' => [ 'NodeList$member' => NULL, ], ], 'NodeId' => [ 'base' => NULL, 'refs' => [ 'CodeGenConfigurationNodes$key' => NULL, 'ManyInputs$member' => NULL, 'Merge$Source' => 'The source DynamicFrame
that will be merged with a staging DynamicFrame
.
A table, or a column in a table.
', 'TwoInputs$member' => NULL, ], ], 'NodeIdList' => [ 'base' => NULL, 'refs' => [ 'ResumeWorkflowRunRequest$NodeIds' => 'A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
', 'ResumeWorkflowRunResponse$NodeIds' => 'A list of the node IDs for the nodes that were actually restarted.
', ], ], 'NodeList' => [ 'base' => NULL, 'refs' => [ 'WorkflowGraph$Nodes' => 'A list of the the Glue components belong to the workflow represented as nodes.
', ], ], 'NodeName' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Name' => 'The name of the transform node.
', 'AmazonRedshiftSource$Name' => 'The name of the Amazon Redshift source.
', 'AmazonRedshiftTarget$Name' => 'The name of the Amazon Redshift target.
', 'ApplyMapping$Name' => 'The name of the transform node.
', 'AthenaConnectorSource$Name' => 'The name of the data source.
', 'BasicCatalogTarget$Name' => 'The name of your data target.
', 'CatalogDeltaSource$Name' => 'The name of the Delta Lake data source.
', 'CatalogHudiSource$Name' => 'The name of the Hudi data source.
', 'CatalogKafkaSource$Name' => 'The name of the data store.
', 'CatalogKinesisSource$Name' => 'The name of the data source.
', 'CatalogSource$Name' => 'The name of the data store.
', 'ConnectorDataSource$Name' => 'The name of this source node.
', 'ConnectorDataTarget$Name' => 'The name of this target node.
', 'CustomCode$Name' => 'The name of the transform node.
', 'DQDLAliases$key' => NULL, 'DirectJDBCSource$Name' => 'The name of the JDBC source connection.
', 'DirectKafkaSource$Name' => 'The name of the data store.
', 'DirectKinesisSource$Name' => 'The name of the data source.
', 'DropDuplicates$Name' => 'The name of the transform node.
', 'DropFields$Name' => 'The name of the transform node.
', 'DropNullFields$Name' => 'The name of the transform node.
', 'DynamoDBCatalogSource$Name' => 'The name of the data source.
', 'EvaluateDataQuality$Name' => 'The name of the data quality evaluation.
', 'EvaluateDataQualityMultiFrame$Name' => 'The name of the data quality evaluation.
', 'FillMissingValues$Name' => 'The name of the transform node.
', 'Filter$Name' => 'The name of the transform node.
', 'GovernedCatalogSource$Name' => 'The name of the data store.
', 'GovernedCatalogTarget$Name' => 'The name of the data target.
', 'JDBCConnectorSource$Name' => 'The name of the data source.
', 'JDBCConnectorTarget$Name' => 'The name of the data target.
', 'Join$Name' => 'The name of the transform node.
', 'Merge$Name' => 'The name of the transform node.
', 'MicrosoftSQLServerCatalogSource$Name' => 'The name of the data source.
', 'MicrosoftSQLServerCatalogTarget$Name' => 'The name of the data target.
', 'MySQLCatalogSource$Name' => 'The name of the data source.
', 'MySQLCatalogTarget$Name' => 'The name of the data target.
', 'OracleSQLCatalogSource$Name' => 'The name of the data source.
', 'OracleSQLCatalogTarget$Name' => 'The name of the data target.
', 'PIIDetection$Name' => 'The name of the transform node.
', 'PostgreSQLCatalogSource$Name' => 'The name of the data source.
', 'PostgreSQLCatalogTarget$Name' => 'The name of the data target.
', 'Recipe$Name' => 'The name of the Glue Studio node.
', 'RedshiftSource$Name' => 'The name of the Amazon Redshift data store.
', 'RedshiftTarget$Name' => 'The name of the data target.
', 'RelationalCatalogSource$Name' => 'The name of the data source.
', 'RenameField$Name' => 'The name of the transform node.
', 'S3CatalogDeltaSource$Name' => 'The name of the Delta Lake data source.
', 'S3CatalogHudiSource$Name' => 'The name of the Hudi data source.
', 'S3CatalogSource$Name' => 'The name of the data store.
', 'S3CatalogTarget$Name' => 'The name of the data target.
', 'S3CsvSource$Name' => 'The name of the data store.
', 'S3DeltaCatalogTarget$Name' => 'The name of the data target.
', 'S3DeltaDirectTarget$Name' => 'The name of the data target.
', 'S3DeltaSource$Name' => 'The name of the Delta Lake source.
', 'S3DirectTarget$Name' => 'The name of the data target.
', 'S3GlueParquetTarget$Name' => 'The name of the data target.
', 'S3HudiCatalogTarget$Name' => 'The name of the data target.
', 'S3HudiDirectTarget$Name' => 'The name of the data target.
', 'S3HudiSource$Name' => 'The name of the Hudi source.
', 'S3JsonSource$Name' => 'The name of the data store.
', 'S3ParquetSource$Name' => 'The name of the data store.
', 'SelectFields$Name' => 'The name of the transform node.
', 'SelectFromCollection$Name' => 'The name of the transform node.
', 'SnowflakeSource$Name' => 'The name of the Snowflake data source.
', 'SnowflakeTarget$Name' => 'The name of the Snowflake target.
', 'SparkConnectorSource$Name' => 'The name of the data source.
', 'SparkConnectorTarget$Name' => 'The name of the data target.
', 'SparkSQL$Name' => 'The name of the transform node.
', 'Spigot$Name' => 'The name of the transform node.
', 'SplitFields$Name' => 'The name of the transform node.
', 'Union$Name' => 'The name of the transform node.
', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'Node$Type' => 'The type of Glue component represented by the node.
', ], ], 'NonNegativeDouble' => [ 'base' => NULL, 'refs' => [ 'BinaryColumnStatisticsData$AverageLength' => 'The average bit sequence length in the column.
', 'ColumnStatisticsTaskRun$DPUSeconds' => 'The calculated DPU usage in seconds for all autoscaled workers.
', 'CrawlerHistory$DPUHour' => 'The number of data processing units (DPU) used in hours for the crawl.
', 'CrawlerMetrics$TimeLeftSeconds' => 'The estimated time left to complete a running crawl.
', 'CrawlerMetrics$LastRuntimeSeconds' => 'The duration of the crawler\'s most recent run, in seconds.
', 'CrawlerMetrics$MedianRuntimeSeconds' => 'The median duration of this crawler\'s runs, in seconds.
', 'StringColumnStatisticsData$AverageLength' => 'The average string length in the column.
', ], ], 'NonNegativeInt' => [ 'base' => NULL, 'refs' => [ 'SelectFromCollection$Index' => 'The index for the DynamicFrame to be selected.
', ], ], 'NonNegativeInteger' => [ 'base' => NULL, 'refs' => [ 'CrawlerMetrics$TablesCreated' => 'The number of tables created by this crawler.
', 'CrawlerMetrics$TablesUpdated' => 'The number of tables updated by this crawler.
', 'CrawlerMetrics$TablesDeleted' => 'The number of tables deleted by this crawler.
', 'Segment$SegmentNumber' => 'The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber
values range from 0 through 3.
The retention time for this table.
', 'TableInput$Retention' => 'The retention time for this table.
', ], ], 'NonNegativeLong' => [ 'base' => NULL, 'refs' => [ 'BinaryColumnStatisticsData$MaximumLength' => 'The size of the longest bit sequence in the column.
', 'BinaryColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'BooleanColumnStatisticsData$NumberOfTrues' => 'The number of true values in the column.
', 'BooleanColumnStatisticsData$NumberOfFalses' => 'The number of false values in the column.
', 'BooleanColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DateColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DateColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'DecimalColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DecimalColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'DoubleColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DoubleColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'LongColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'LongColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'StringColumnStatisticsData$MaximumLength' => 'The size of the longest string in the column.
', 'StringColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'StringColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', ], ], 'NotificationProperty' => [ 'base' => 'Specifies configuration properties of a notification.
', 'refs' => [ 'Action$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', 'CreateJobRequest$NotificationProperty' => 'Specifies configuration properties of a job notification.
', 'Job$NotificationProperty' => 'Specifies configuration properties of a job notification.
', 'JobRun$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', 'JobUpdate$NotificationProperty' => 'Specifies the configuration properties of a job notification.
', 'StartJobRunRequest$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', ], ], 'NotifyDelayAfter' => [ 'base' => NULL, 'refs' => [ 'NotificationProperty$NotifyDelayAfter' => 'After a job run starts, the number of minutes to wait before sending a job run delay notification.
', ], ], 'NullCheckBoxList' => [ 'base' => 'Represents whether certain values are recognized as null values for removal.
', 'refs' => [ 'DropNullFields$NullCheckBoxList' => 'A structure that represents whether certain values are recognized as null values for removal.
', ], ], 'NullValueField' => [ 'base' => 'Represents a custom null value such as a zeros or other value being used as a null placeholder unique to the dataset.
', 'refs' => [ 'NullValueFields$member' => NULL, ], ], 'NullValueFields' => [ 'base' => NULL, 'refs' => [ 'DropNullFields$NullTextList' => 'A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The DropNullFields
transform removes custom null values only if both the value of the null placeholder and the datatype match the data.
All columns request for audit.
', 'BatchGetBlueprintsRequest$IncludeBlueprint' => 'Specifies whether or not to include the blueprint in the response.
', 'BatchGetBlueprintsRequest$IncludeParameterSpec' => 'Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.
', 'BatchGetWorkflowsRequest$IncludeGraph' => 'Specifies whether to include a graph when returning the workflow resource metadata.
', 'CreateCsvClassifierRequest$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true.
', 'CreateCsvClassifierRequest$AllowSingleColumn' => 'Enables the processing of files that contain only one column.
', 'CreateCsvClassifierRequest$CustomDatatypeConfigured' => 'Enables the configuration of custom datatypes.
', 'CsvClassifier$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true
.
Enables the processing of files that contain only one column.
', 'CsvClassifier$CustomDatatypeConfigured' => 'Enables the custom datatype to be configured.
', 'DataQualityEvaluationRunAdditionalRunOptions$CloudWatchMetricsEnabled' => 'Whether or not to enable CloudWatch metrics.
', 'DeltaTarget$WriteManifest' => 'Specifies whether to write the manifest files to the Delta table path.
', 'DeltaTarget$CreateNativeDeltaTable' => 'Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
', 'DynamoDBTarget$scanAll' => 'Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true
means to scan all records, while a value of false
means to sample the records. If no value is specified, the value defaults to true
.
Indicates whether or not the exception relates to a federated source.
', 'FindMatchesParameters$EnforceProvidedLabels' => 'The value to switch on or off to force the output to match the provided labels from users. If the value is True
, the find matches
transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False
, the find matches
transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
', 'GetBlueprintRequest$IncludeBlueprint' => 'Specifies whether or not to include the blueprint in the response.
', 'GetBlueprintRequest$IncludeParameterSpec' => 'Specifies whether or not to include the parameter specification.
', 'GetWorkflowRequest$IncludeGraph' => 'Specifies whether to include a graph when returning the workflow resource metadata.
', 'GetWorkflowRunRequest$IncludeGraph' => 'Specifies whether to include the workflow graph in response or not.
', 'GetWorkflowRunsRequest$IncludeGraph' => 'Specifies whether to include the workflow graph in response or not.
', 'InvalidInputException$FromFederationSource' => 'Indicates whether or not the exception relates to a federated source.
', 'LakeFormationConfiguration$UseLakeFormationCredentials' => 'Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
', 'MongoDBTarget$ScanAll' => 'Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true
means to scan all records, while a value of false
means to sample the records. If no value is specified, the value defaults to true
.
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
', 'TableOptimizerConfiguration$enabled' => 'Whether table optimization is enabled.
', 'UpdateCsvClassifierRequest$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true.
', 'UpdateCsvClassifierRequest$AllowSingleColumn' => 'Enables the processing of files that contain only one column.
', 'UpdateCsvClassifierRequest$CustomDatatypeConfigured' => 'Specifies the configuration of custom datatypes.
', 'ViewDefinition$IsProtected' => 'You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine\'s documentation to understand the guarantees provided, if any.
', 'ViewDefinitionInput$IsProtected' => 'You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine\'s documentation to understand the guarantees provided, if any.
', 'ViewRepresentation$IsStale' => 'Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
', ], ], 'NullableDouble' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$MaxCapacity' => 'For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
MaxCapacity
and NumberOfWorkers
must both be at least 1.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
', 'DataQualityMetricValues$ActualValue' => 'The actual value of the data quality metric.
', 'DataQualityMetricValues$ExpectedValue' => 'The expected value of the data quality metric according to the analysis of historical data.
', 'DataQualityMetricValues$LowerLimit' => 'The lower limit of the data quality metric value according to the analysis of historical data.
', 'DataQualityMetricValues$UpperLimit' => 'The upper limit of the data quality metric value according to the analysis of historical data.
', 'DynamoDBTarget$scanRate' => 'The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
', 'EvaluatedMetricsMap$value' => NULL, 'GetMLTransformResponse$MaxCapacity' => 'The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
This field can be set for either job runs with execution class FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X
, 2 for G.2X
, or 0.25 for G.025X
workers). This value may be different than the executionEngineRuntime
* MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity
. Therefore, it is possible that the value of DPUSeconds
is less than executionEngineRuntime
* MaxCapacity
.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
MaxCapacity
and NumberOfWorkers
must both be at least 1.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
', 'Session$ExecutionTime' => 'The total time the session ran for.
', 'Session$DPUSeconds' => 'The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
', 'StartJobRunRequest$MaxCapacity' => 'For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
The number of workers of a defined workerType
that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X
, and 149 for G.2X
.
The number of workers of a defined workerType
that are allocated to the development endpoint.
The number of workers of a defined workerType
that are allocated when a job runs.
The number of workers of a defined workerType
that are allocated when this task runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
The maximum number of times to retry a task for this transform after a task run fails.
', 'CreateSessionRequest$NumberOfWorkers' => 'The number of workers of a defined WorkerType
to use for the session.
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', 'DataQualityRulesetListDetails$RuleCount' => 'The number of rules in the ruleset.
', 'DevEndpoint$NumberOfWorkers' => 'The number of workers of a defined workerType
that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X
, and 149 for G.2X
.
The number of G.1X
workers to be used in the run. The default is 5.
The number of G.1X
workers to be used in the run. The default is 5.
The number of workers of a defined workerType
that are allocated when this task runs.
The maximum number of times to retry a task for this transform after a task run fails.
', 'HudiTarget$MaximumTraversalDepth' => 'The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
', 'IcebergTarget$MaximumTraversalDepth' => 'The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
', 'Job$NumberOfWorkers' => 'The number of workers of a defined workerType
that are allocated when a job runs.
The number of workers of a defined workerType
that are allocated when a job runs.
The number of workers of a defined workerType
that are allocated when a job runs.
The number of workers of a defined workerType
that are allocated when a task of the transform runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
The maximum number of times to retry after an MLTaskRun
of the machine learning transform fails.
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
', 'Session$NumberOfWorkers' => 'The number of workers of a defined WorkerType
to use for the session.
The number of G.1X
workers to be used in the run. The default is 5.
The number of G.1X
workers to be used in the run. The default is 5.
The number of workers of a defined workerType
that are allocated when a job runs.
Number of events in the batch.
', 'StartingEventBatchCondition$BatchWindow' => 'Duration of the batch window in seconds.
', 'UpdateMLTransformRequest$NumberOfWorkers' => 'The number of workers of a defined workerType
that are allocated when this task runs.
The maximum number of times to retry a task for this transform after a task run fails.
', 'UpdateWorkflowRequest$MaxConcurrentRuns' => 'You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', 'Workflow$MaxConcurrentRuns' => 'You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', ], ], 'NullableString' => [ 'base' => NULL, 'refs' => [ 'QuerySessionContext$ClusterId' => 'An identifier string for the consumer cluster.
', ], ], 'OAuth2ClientApplication' => [ 'base' => 'The OAuth2 client app used for the connection.
', 'refs' => [ 'OAuth2Properties$OAuth2ClientApplication' => 'The client application type. For example, AWS_MANAGED or USER_MANAGED.
', 'OAuth2PropertiesInput$OAuth2ClientApplication' => 'The client application type in the CreateConnection request. For example, AWS_MANAGED
or USER_MANAGED
.
The OAuth2 grant type. For example, AUTHORIZATION_CODE
, JWT_BEARER
, or CLIENT_CREDENTIALS
.
The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE
, JWT_BEARER
, or CLIENT_CREDENTIALS
.
A structure containing properties for OAuth2 authentication.
', 'refs' => [ 'AuthenticationConfiguration$OAuth2Properties' => 'The properties for OAuth2 authentication.
', ], ], 'OAuth2PropertiesInput' => [ 'base' => 'A structure containing properties for OAuth2 in the CreateConnection request.
', 'refs' => [ 'AuthenticationConfigurationInput$OAuth2Properties' => 'The properties for OAuth2 authentication in the CreateConnection request.
', ], ], 'OneInput' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Inputs' => 'Specifies the fields and rows to use as inputs for the aggregate transform.
', 'AmazonRedshiftTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'ApplyMapping$Inputs' => 'The data inputs identified by their node names.
', 'BasicCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'ConnectorDataTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'DropDuplicates$Inputs' => 'The data inputs identified by their node names.
', 'DropFields$Inputs' => 'The data inputs identified by their node names.
', 'DropNullFields$Inputs' => 'The data inputs identified by their node names.
', 'DynamicTransform$Inputs' => 'Specifies the inputs for the dynamic transform that are required.
', 'EvaluateDataQuality$Inputs' => 'The inputs of your data quality evaluation.
', 'FillMissingValues$Inputs' => 'The data inputs identified by their node names.
', 'Filter$Inputs' => 'The data inputs identified by their node names.
', 'GovernedCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'JDBCConnectorTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'MicrosoftSQLServerCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'MySQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'OracleSQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'PIIDetection$Inputs' => 'The node ID inputs to the transform.
', 'PostgreSQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'Recipe$Inputs' => 'The nodes that are inputs to the recipe node, identified by id.
', 'RedshiftTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'RenameField$Inputs' => 'The data inputs identified by their node names.
', 'S3CatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DeltaCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DeltaDirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3GlueParquetTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3HudiCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3HudiDirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'SelectFields$Inputs' => 'The data inputs identified by their node names.
', 'SelectFromCollection$Inputs' => 'The data inputs identified by their node names.
', 'SnowflakeTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'SparkConnectorTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'Spigot$Inputs' => 'The data inputs identified by their node names.
', 'SplitFields$Inputs' => 'The data inputs identified by their node names.
', ], ], 'OpenTableFormatInput' => [ 'base' => 'A structure representing an open format table.
', 'refs' => [ 'CreateTableRequest$OpenTableFormatInput' => 'Specifies an OpenTableFormatInput
structure when creating an open format table.
The operation is not available in the region.
', 'refs' => [], ], 'OperationTimeoutException' => [ 'base' => 'The operation timed out.
', 'refs' => [], ], 'Option' => [ 'base' => 'Specifies an option value.
', 'refs' => [ 'AmazonRedshiftNodeData$Connection' => 'The Glue connection to the Redshift cluster.
', 'AmazonRedshiftNodeData$Schema' => 'The Redshift schema name when working with a direct connection.
', 'AmazonRedshiftNodeData$Table' => 'The Redshift table name when working with a direct connection.
', 'AmazonRedshiftNodeData$CatalogDatabase' => 'The name of the Glue Data Catalog database when working with a data catalog.
', 'AmazonRedshiftNodeData$CatalogTable' => 'The Glue Data Catalog table name when working with a data catalog.
', 'AmazonRedshiftNodeData$IamRole' => 'Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
', 'OptionList$member' => NULL, 'SnowflakeNodeData$Connection' => 'Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
', 'SnowflakeNodeData$IamRole' => 'Not currently used.
', ], ], 'OptionList' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$TableSchema' => 'The array of schema output for a given node.
', 'AmazonRedshiftNodeData$SelectedColumns' => 'The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
', 'SnowflakeNodeData$SelectedColumns' => 'Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value
, label
and description
keys. Each structure describes a column.
Manually defines the target schema for the node. A list of structures with value
, label
and description
keys. Each structure defines a column.
Specifies an Oracle data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$OracleSQLCatalogSource' => 'Specifies an Oracle data source in the Glue Data Catalog.
', ], ], 'OracleSQLCatalogTarget' => [ 'base' => 'Specifies a target that uses Oracle SQL.
', 'refs' => [ 'CodeGenConfigurationNode$OracleSQLCatalogTarget' => 'Specifies a target that uses Oracle SQL.
', ], ], 'OrchestrationArgumentsMap' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$DefaultArguments' => 'A map array of key-value pairs. Max is 75 pairs.
', 'Session$DefaultArguments' => 'A map array of key-value pairs. Max is 75 pairs.
', ], ], 'OrchestrationArgumentsValue' => [ 'base' => NULL, 'refs' => [ 'OrchestrationArgumentsMap$value' => NULL, ], ], 'OrchestrationIAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'BlueprintRun$RoleArn' => 'The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
', 'StartBlueprintRunRequest$RoleArn' => 'Specifies the IAM role used to create the workflow.
', ], ], 'OrchestrationNameString' => [ 'base' => NULL, 'refs' => [ 'BatchGetBlueprintNames$member' => NULL, 'Blueprint$Name' => 'The name of the blueprint.
', 'BlueprintDetails$BlueprintName' => 'The name of the blueprint.
', 'BlueprintNames$member' => NULL, 'BlueprintRun$BlueprintName' => 'The name of the blueprint.
', 'CancelStatementRequest$RequestOrigin' => 'The origin of the request to cancel the statement.
', 'CreateBlueprintRequest$Name' => 'The name of the blueprint.
', 'CreateSessionRequest$RequestOrigin' => 'The origin of the request.
', 'DeleteSessionRequest$RequestOrigin' => 'The name of the origin of the delete session request.
', 'GetBlueprintRunRequest$BlueprintName' => 'The name of the blueprint.
', 'GetSessionRequest$RequestOrigin' => 'The origin of the request.
', 'GetStatementRequest$RequestOrigin' => 'The origin of the request.
', 'ListSessionsRequest$RequestOrigin' => 'The origin of the request.
', 'ListStatementsRequest$RequestOrigin' => 'The origin of the request to list statements.
', 'OrchestrationArgumentsMap$key' => NULL, 'RunStatementRequest$RequestOrigin' => 'The origin of the request.
', 'StartBlueprintRunRequest$BlueprintName' => 'The name of the blueprint.
', 'StopSessionRequest$RequestOrigin' => 'The origin of the request.
', 'UpdateBlueprintRequest$Name' => 'The name of the blueprint.
', ], ], 'OrchestrationPageSize200' => [ 'base' => NULL, 'refs' => [ 'GetJobRunsRequest$MaxResults' => 'The maximum size of the response.
', 'GetTriggersRequest$MaxResults' => 'The maximum size of the response.
', 'ListTriggersRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListUsageProfilesRequest$MaxResults' => 'The maximum number of usage profiles to return in a single response.
', ], ], 'OrchestrationPageSize25' => [ 'base' => NULL, 'refs' => [ 'ListBlueprintsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListWorkflowsRequest$MaxResults' => 'The maximum size of a list to return.
', ], ], 'OrchestrationRoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$Role' => 'The IAM Role ARN
', 'Session$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
', ], ], 'OrchestrationS3Location' => [ 'base' => NULL, 'refs' => [ 'CreateBlueprintRequest$BlueprintLocation' => 'Specifies a path in Amazon S3 where the blueprint is published.
', 'UpdateBlueprintRequest$BlueprintLocation' => 'Specifies a path in Amazon S3 where the blueprint is published.
', ], ], 'OrchestrationStatementCodeString' => [ 'base' => NULL, 'refs' => [ 'RunStatementRequest$Code' => 'The statement code to be run.
', ], ], 'OrchestrationStringList' => [ 'base' => NULL, 'refs' => [ 'ConnectionsList$Connections' => 'A list of connections used by the job.
', 'StatementOutput$Traceback' => 'The traceback of the output.
', ], ], 'OrchestrationToken' => [ 'base' => NULL, 'refs' => [ 'ListSessionsRequest$NextToken' => 'The token for the next set of results, or null if there are no more result.
', 'ListSessionsResponse$NextToken' => 'The token for the next set of results, or null if there are no more result.
', 'ListStatementsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListStatementsResponse$NextToken' => 'A continuation token, if not all statements have yet been returned.
', 'ListUsageProfilesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'ListUsageProfilesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', ], ], 'Order' => [ 'base' => 'Specifies the sort order of a sorted column.
', 'refs' => [ 'OrderList$member' => NULL, ], ], 'OrderList' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$SortColumns' => 'A list specifying the sort order of each bucket in the table.
', ], ], 'OtherMetadataValueList' => [ 'base' => NULL, 'refs' => [ 'MetadataInfo$OtherMetadataValueList' => 'Other metadata belonging to the same metadata key.
', ], ], 'OtherMetadataValueListItem' => [ 'base' => 'A structure containing other metadata for a schema version belonging to the same metadata key.
', 'refs' => [ 'OtherMetadataValueList$member' => NULL, ], ], 'PIIDetection' => [ 'base' => 'Specifies a transform that identifies, removes or masks PII data.
', 'refs' => [ 'CodeGenConfigurationNode$PIIDetection' => 'Specifies a transform that identifies, removes or masks PII data.
', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'GetBlueprintRunsRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetClassifiersRequest$MaxResults' => 'The size of the list to return (optional).
', 'GetColumnStatisticsTaskRunsRequest$MaxResults' => 'The maximum size of the response.
', 'GetConnectionsRequest$MaxResults' => 'The maximum number of connections to return in one response.
', 'GetCrawlerMetricsRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetCrawlersRequest$MaxResults' => 'The number of crawlers to return on each call.
', 'GetDevEndpointsRequest$MaxResults' => 'The maximum size of information to return.
', 'GetJobsRequest$MaxResults' => 'The maximum size of the response.
', 'GetMLTaskRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetMLTransformsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetPartitionsRequest$MaxResults' => 'The maximum number of partitions to return in a single response.
', 'GetResourcePoliciesRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetSecurityConfigurationsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetUnfilteredPartitionsMetadataRequest$MaxResults' => 'The maximum number of partitions to return in a single response.
', 'GetWorkflowRunsRequest$MaxResults' => 'The maximum number of workflow runs to be included in the response.
', 'ListColumnStatisticsTaskRunsRequest$MaxResults' => 'The maximum size of the response.
', 'ListCrawlersRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListCrawlsRequest$MaxResults' => 'The maximum number of results to return. The default is 20, and maximum is 100.
', 'ListCustomEntityTypesRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityResultsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRuleRecommendationRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRulesetEvaluationRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRulesetsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDevEndpointsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListJobsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListMLTransformsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListSessionsRequest$MaxResults' => 'The maximum number of results.
', 'SearchTablesRequest$MaxResults' => 'The maximum number of tables to return in a single response.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'GetMLTaskRunsRequest$NextToken' => 'A token for pagination of the results. The default is empty.
', 'GetMLTaskRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'GetMLTransformsRequest$NextToken' => 'A paginated token to offset the results.
', 'GetMLTransformsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListCustomEntityTypesRequest$NextToken' => 'A paginated token to offset the results.
', 'ListCustomEntityTypesResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityResultsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityResultsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRuleRecommendationRunsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRuleRecommendationRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRulesetEvaluationRunsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRulesetEvaluationRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRulesetsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRulesetsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListMLTransformsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListMLTransformsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', ], ], 'ParamType' => [ 'base' => NULL, 'refs' => [ 'TransformConfigParameter$Type' => 'Specifies the parameter type in the config file of the dynamic transform.
', 'TransformConfigParameter$ListType' => 'Specifies the list type of the parameter in the config file of the dynamic transform.
', ], ], 'ParametersMap' => [ 'base' => NULL, 'refs' => [ 'Column$Parameters' => 'These key-value pairs define properties associated with the column.
', 'Database$Parameters' => 'These key-value pairs define parameters and properties of the database.
', 'DatabaseInput$Parameters' => 'These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
', 'Partition$Parameters' => 'These key-value pairs define partition parameters.
', 'PartitionInput$Parameters' => 'These key-value pairs define partition parameters.
', 'SerDeInfo$Parameters' => 'These key-value pairs define initialization parameters for the SerDe.
', 'StorageDescriptor$Parameters' => 'The user-supplied properties in key-value form.
', 'Table$Parameters' => 'These key-value pairs define properties associated with the table.
', 'TableInput$Parameters' => 'These key-value pairs define properties associated with the table.
', ], ], 'ParametersMapValue' => [ 'base' => NULL, 'refs' => [ 'ParametersMap$value' => NULL, ], ], 'ParquetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3GlueParquetTarget$Compression' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Represents a slice of table data.
', 'refs' => [ 'GetPartitionResponse$Partition' => 'The requested information, in the form of a Partition
object.
A Partition object containing the partition metadata.
', 'PartitionList$member' => NULL, 'UnfilteredPartition$Partition' => 'The partition object.
', ], ], 'PartitionError' => [ 'base' => 'Contains information about a partition error.
', 'refs' => [ 'PartitionErrors$member' => NULL, ], ], 'PartitionErrors' => [ 'base' => NULL, 'refs' => [ 'BatchCreatePartitionResponse$Errors' => 'The errors encountered when trying to create the requested partitions.
', 'BatchDeletePartitionResponse$Errors' => 'The errors encountered when trying to delete the requested partitions.
', ], ], 'PartitionIndex' => [ 'base' => 'A structure for a partition index.
', 'refs' => [ 'CreatePartitionIndexRequest$PartitionIndex' => 'Specifies a PartitionIndex
structure to create a partition index in an existing table.
A descriptor for a partition index in a table.
', 'refs' => [ 'PartitionIndexDescriptorList$member' => NULL, ], ], 'PartitionIndexDescriptorList' => [ 'base' => NULL, 'refs' => [ 'GetPartitionIndexesResponse$PartitionIndexDescriptorList' => 'A list of index descriptors.
', ], ], 'PartitionIndexList' => [ 'base' => NULL, 'refs' => [ 'CreateTableRequest$PartitionIndexes' => 'A list of partition indexes, PartitionIndex
structures, to create in the table.
The status of the partition index.
The possible statuses are:
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
ACTIVE: The index creation succeeds.
FAILED: The index creation fails.
DELETING: The index is deleted from the list of indexes.
The structure used to create and update a partition.
', 'refs' => [ 'BatchUpdatePartitionRequestEntry$PartitionInput' => 'The structure used to update a partition.
', 'CreatePartitionRequest$PartitionInput' => 'A PartitionInput
structure defining the partition to be created.
The new partition object to update the partition to.
The Values
property can\'t be changed. If you want to change the partition key values for a partition, delete and recreate the partition.
A list of PartitionInput
structures that define the partitions to be created.
A list of the requested partitions.
', 'GetPartitionsResponse$Partitions' => 'A list of requested partitions.
', ], ], 'PartitionValueList' => [ 'base' => 'Contains a list of values defining partitions.
', 'refs' => [ 'BackfillErroredPartitionsList$member' => NULL, 'BatchDeletePartitionValueList$member' => NULL, 'BatchGetPartitionValueList$member' => NULL, ], ], 'Path' => [ 'base' => NULL, 'refs' => [ 'DynamoDBTarget$Path' => 'The name of the DynamoDB table to crawl.
', 'JdbcTarget$Path' => 'The path of the JDBC target.
', 'MongoDBTarget$Path' => 'The path of the Amazon DocumentDB or MongoDB target (database/collection).
', 'PathList$member' => NULL, 'S3Target$Path' => 'The path to the Amazon S3 target.
', ], ], 'PathList' => [ 'base' => NULL, 'refs' => [ 'DeltaTarget$DeltaTables' => 'A list of the Amazon S3 paths to the Delta tables.
', 'HudiTarget$Paths' => 'An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
', 'HudiTarget$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'IcebergTarget$Paths' => 'One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix
.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'JdbcTarget$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'S3Target$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', ], ], 'Permission' => [ 'base' => NULL, 'refs' => [ 'PermissionList$member' => NULL, ], ], 'PermissionList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredTableMetadataRequest$Permissions' => 'The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
', 'GetUnfilteredTableMetadataResponse$Permissions' => 'The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
', 'PrincipalPermissions$Permissions' => 'The permissions that are granted to the principal.
', ], ], 'PermissionType' => [ 'base' => NULL, 'refs' => [ 'PermissionTypeList$member' => NULL, ], ], 'PermissionTypeList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$SupportedPermissionTypes' => '(Required) A list of supported permission types.
', 'GetUnfilteredPartitionsMetadataRequest$SupportedPermissionTypes' => 'A list of supported permission types.
', 'GetUnfilteredTableMetadataRequest$SupportedPermissionTypes' => 'Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata
API operation. Accepted values are:
COLUMN_PERMISSION
- Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.
CELL_FILTER_PERMISSION
- Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.
NESTED_PERMISSION
- Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.
NESTED_CELL_PERMISSION
- Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.
Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.
Important: If you provide a supported permission type that doesn\'t match the user\'s level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata
operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.
The operation timed out.
', 'refs' => [], ], 'PhysicalConnectionRequirements' => [ 'base' => 'The OAuth client app in GetConnection response.
', 'refs' => [ 'Connection$PhysicalConnectionRequirements' => 'The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to make this connection successfully.
The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to successfully make this connection.
Indicates the type of PIIDetection transform.
', ], ], 'PolicyJsonString' => [ 'base' => NULL, 'refs' => [ 'GetResourcePolicyResponse$PolicyInJson' => 'Contains the requested policy document, in JSON format.
', 'GluePolicy$PolicyInJson' => 'Contains the requested policy document, in JSON format.
', 'PutResourcePolicyRequest$PolicyInJson' => 'Contains the policy document to set, in JSON format.
', ], ], 'PollingTime' => [ 'base' => NULL, 'refs' => [ 'StreamingDataPreviewOptions$PollingTime' => 'The polling time in milliseconds.
', ], ], 'PositiveInteger' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$NumberOfWorkers' => 'The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
', ], ], 'PositiveLong' => [ 'base' => NULL, 'refs' => [ 'StreamingDataPreviewOptions$RecordPollingLimit' => 'The limit to the number of records polled.
', ], ], 'PostgreSQLCatalogSource' => [ 'base' => 'Specifies a PostgresSQL data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$PostgreSQLCatalogSource' => 'Specifies a PostgresSQL data source in the Glue Data Catalog.
', ], ], 'PostgreSQLCatalogTarget' => [ 'base' => 'Specifies a target that uses Postgres SQL.
', 'refs' => [ 'CodeGenConfigurationNode$PostgreSQLCatalogTarget' => 'Specifies a target that uses Postgres SQL.
', ], ], 'Predecessor' => [ 'base' => 'A job run that was used in the predicate of a conditional trigger that triggered this job run.
', 'refs' => [ 'PredecessorList$member' => NULL, ], ], 'PredecessorList' => [ 'base' => NULL, 'refs' => [ 'JobRun$PredecessorRuns' => 'A list of predecessors to this job run.
', ], ], 'Predicate' => [ 'base' => 'Defines the predicate of the trigger, which determines when it fires.
', 'refs' => [ 'CreateTriggerRequest$Predicate' => 'A predicate to specify when the new trigger should fire.
This field is required when the trigger type is CONDITIONAL
.
The predicate of this trigger, which defines when it will fire.
', 'TriggerUpdate$Predicate' => 'The predicate of this trigger, which defines when it will fire.
', ], ], 'PredicateString' => [ 'base' => NULL, 'refs' => [ 'ColumnRowFilter$RowFilterExpression' => 'A string containing the row-level filter expression.
', 'GetPartitionsRequest$Expression' => 'An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE
filter clause. The SQL statement parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression
API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume \'variable a\' holds 10 and \'variable b\' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the partitionKey
type is created as a STRING
, to be compatible with the catalog partitions.
Sample API Call:
', 'GetUnfilteredPartitionsMetadataRequest$Expression' => 'An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE
filter clause. The SQL statement parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression
API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume \'variable a\' holds 10 and \'variable b\' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
', 'GetUnfilteredTableMetadataResponse$RowFilter' => 'The filter that applies to the table. For example when applying the filter in SQL, it would go in the WHERE
clause and can be evaluated by using an AND
operator with any other predicates applied by the user querying the table.
Permissions granted to a principal.
', 'refs' => [ 'PrincipalPermissionsList$member' => NULL, ], ], 'PrincipalPermissionsList' => [ 'base' => NULL, 'refs' => [ 'Database$CreateTableDefaultPermissions' => 'Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
', 'DatabaseInput$CreateTableDefaultPermissions' => 'Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'UserDefinedFunction$OwnerType' => 'The owner type.
', 'UserDefinedFunctionInput$OwnerType' => 'The owner type.
', ], ], 'Prob' => [ 'base' => NULL, 'refs' => [ 'Spigot$Prob' => 'The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
', ], ], 'ProfileConfiguration' => [ 'base' => 'Specifies the job and session values that an admin configures in an Glue usage profile.
', 'refs' => [ 'CreateUsageProfileRequest$Configuration' => 'A ProfileConfiguration
object specifying the job and session values for the profile.
A ProfileConfiguration
object specifying the job and session values for the profile.
A ProfileConfiguration
object specifying the job and session values for the profile.
Defines a property predicate.
', 'refs' => [ 'SearchPropertyPredicates$member' => NULL, ], ], 'PublicKeysList' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$PublicKeys' => 'A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint
API with the public key content in the deletePublicKeys
attribute, and the list of new keys in the addPublicKeys
attribute.
A list of public keys to be used by the DevEndpoints
for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint
API operation with the public key content in the deletePublicKeys
attribute, and the list of new keys in the addPublicKeys
attribute.
The list of public keys for the DevEndpoint
to use.
The list of public keys to be deleted from the DevEndpoint
.
The Python script generated from the DAG.
', 'GetDataflowGraphRequest$PythonScript' => 'The Python script to transform.
', 'GetPlanResponse$PythonScript' => 'A Python script to perform the mapping.
', ], ], 'PythonVersionString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$PythonVersion' => 'The Python version being used to run a Python shell job. Allowed values are 2 or 3.
', 'SessionCommand$PythonVersion' => 'Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
', ], ], 'QuerySchemaVersionMetadataInput' => [ 'base' => NULL, 'refs' => [], ], 'QuerySchemaVersionMetadataMaxResults' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', ], ], 'QuerySchemaVersionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'QuerySessionContext' => [ 'base' => 'A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request\'s authorization context.
', 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$QuerySessionContext' => 'A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request\'s authorization context.
', 'GetUnfilteredPartitionsMetadataRequest$QuerySessionContext' => 'A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request\'s authorization context.
', 'GetUnfilteredTableMetadataRequest$QuerySessionContext' => 'A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request\'s authorization context.
', ], ], 'QuoteChar' => [ 'base' => NULL, 'refs' => [ 'S3CsvSource$QuoteChar' => 'Specifies the character to use for quoting. The default is a double quote: \'"\'
. Set this to -1
to turn off quoting entirely.
A Glue Studio node that uses a Glue DataBrew recipe in Glue jobs.
', 'refs' => [ 'CodeGenConfigurationNode$Recipe' => 'Specifies a Glue DataBrew recipe node.
', ], ], 'RecipeReference' => [ 'base' => 'A reference to a Glue DataBrew recipe.
', 'refs' => [ 'Recipe$RecipeReference' => 'A reference to the DataBrew recipe used by the node.
', ], ], 'RecipeVersion' => [ 'base' => NULL, 'refs' => [ 'RecipeReference$RecipeVersion' => 'The RecipeVersion of the DataBrew recipe.
', ], ], 'RecordsCount' => [ 'base' => NULL, 'refs' => [ 'ConfusionMatrix$NumTruePositives' => 'The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumFalsePositives' => 'The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumTrueNegatives' => 'The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumFalseNegatives' => 'The number of matches in the data that the transform didn\'t find, in the confusion matrix for your transform.
', ], ], 'RecrawlBehavior' => [ 'base' => NULL, 'refs' => [ 'RecrawlPolicy$RecrawlBehavior' => 'Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING
specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY
specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE
specifies crawling only the changes identified by Amazon S3 events.
When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in Glue in the developer guide.
', 'refs' => [ 'Crawler$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', 'CreateCrawlerRequest$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', 'UpdateCrawlerRequest$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', ], ], 'RedirectUri' => [ 'base' => NULL, 'refs' => [ 'AuthorizationCodeProperties$RedirectUri' => 'The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.
', ], ], 'RedshiftSource' => [ 'base' => 'Specifies an Amazon Redshift data store.
', 'refs' => [ 'CodeGenConfigurationNode$RedshiftSource' => 'Specifies an Amazon Redshift data store.
', ], ], 'RedshiftTarget' => [ 'base' => 'Specifies a target that uses Amazon Redshift.
', 'refs' => [ 'CodeGenConfigurationNode$RedshiftTarget' => 'Specifies a target that uses Amazon Redshift.
', ], ], 'RegisterSchemaVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'RegisterSchemaVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegistryId' => [ 'base' => 'A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'refs' => [ 'CreateSchemaInput$RegistryId' => ' This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id
.
This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'GetRegistryInput$RegistryId' => 'This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'ListSchemasInput$RegistryId' => 'A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'UpdateRegistryInput$RegistryId' => 'This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', ], ], 'RegistryListDefinition' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesResponse$Registries' => 'An array of RegistryDetailedListItem
objects containing minimal details of each registry.
A structure containing the details for a registry.
', 'refs' => [ 'RegistryListDefinition$member' => NULL, ], ], 'RegistryStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistryResponse$Status' => 'The status of the registry. A successful operation will return the Deleting
status.
The status of the registry.
', 'RegistryListItem$Status' => 'The status of the registry.
', ], ], 'RelationalCatalogSource' => [ 'base' => 'Specifies a Relational database data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$RelationalCatalogSource' => 'Specifies a relational catalog data store in the Glue Data Catalog.
', ], ], 'RemoveSchemaVersionMetadataInput' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSchemaVersionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenameField' => [ 'base' => 'Specifies a transform that renames a single data property key.
', 'refs' => [ 'CodeGenConfigurationNode$RenameField' => 'Specifies a transform that renames a single data property key.
', ], ], 'ReplaceBoolean' => [ 'base' => NULL, 'refs' => [ 'ImportLabelsTaskRunProperties$Replace' => 'Indicates whether to overwrite your existing labels.
', 'StartImportLabelsTaskRunRequest$ReplaceAllLabels' => 'Indicates whether to overwrite your existing labels.
', ], ], 'ResetJobBookmarkRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetJobBookmarkResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotReadyException' => [ 'base' => 'A resource was not ready for a transaction.
', 'refs' => [], ], 'ResourceNumberLimitExceededException' => [ 'base' => 'A resource numerical limit was exceeded.
', 'refs' => [], ], 'ResourceShareType' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$ResourceShareType' => 'Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED
, FOREIGN
or ALL
.
If set to FEDERATED
, will list the federated databases (referencing an external entity) shared with your account.
If set to FOREIGN
, will list the databases shared with your account.
If set to ALL
, will list the databases shared with your account, as well as the databases in yor local account.
Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN
or ALL
.
If set to FOREIGN
, will search the tables shared with your account.
If set to ALL
, will search the tables shared with your account, as well as the tables in yor local account.
The type of the resource.
', ], ], 'ResourceUri' => [ 'base' => 'The URIs for function resources.
', 'refs' => [ 'ResourceUriList$member' => NULL, ], ], 'ResourceUriList' => [ 'base' => NULL, 'refs' => [ 'UserDefinedFunction$ResourceUris' => 'The resource URIs for the function.
', 'UserDefinedFunctionInput$ResourceUris' => 'The resource URIs for the function.
', ], ], 'ResumeWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResumeWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$Role' => 'The IAM role that the service assumes to generate statistics.
', 'Crawler$Role' => 'The Amazon Resource Name (ARN) of an IAM role that\'s used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
', 'CreateCrawlerRequest$Role' => 'The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
', 'UpdateCrawlerRequest$Role' => 'The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$RoleArn' => 'The IAM role for the DevEndpoint
.
The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint
.
The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint
.
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
', 'CreateMLTransformRequest$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
An IAM role supplied to encrypt the results of the run.
', 'GetDataQualityRulesetEvaluationRunResponse$Role' => 'An IAM role supplied to encrypt the results of the run.
', 'GetMLTransformResponse$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
', 'Job$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
', 'JobUpdate$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
', 'MLTransform$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
An IAM role supplied to encrypt the results of the run.
', 'StartDataQualityRulesetEvaluationRunRequest$Role' => 'An IAM role supplied to encrypt the results of the run.
', 'UpdateMLTransformRequest$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
', ], ], 'RowTag' => [ 'base' => NULL, 'refs' => [ 'CreateXMLClassifierRequest$RowTag' => 'The XML tag designating the element that contains each record in an XML document being parsed. This can\'t identify a self-closing element (closed by />
). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row>
is okay, but <row item_a="A" item_b="B" />
is not).
The XML tag designating the element that contains each record in an XML document being parsed. This cannot identify a self-closing element (closed by />
). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row>
is okay, but <row item_a="A" item_b="B" />
is not).
The XML tag designating the element that contains each record in an XML document being parsed. This can\'t identify a self-closing element (closed by />
). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row>
is okay, but <row item_a="A" item_b="B" />
is not).
A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.
', 'StartDataQualityRulesetEvaluationRunRequest$RulesetNames' => 'A list of ruleset names.
', ], ], 'RunId' => [ 'base' => NULL, 'refs' => [ 'GetJobBookmarkRequest$RunId' => 'The unique run identifier associated with this job run.
', 'JobBookmarkEntry$PreviousRunId' => 'The unique run identifier associated with the previous job run.
', 'JobBookmarkEntry$RunId' => 'The run ID number.
', 'ResetJobBookmarkRequest$RunId' => 'The unique run identifier associated with this job run.
', ], ], 'RunMetrics' => [ 'base' => 'Metrics for the optimizer run.
', 'refs' => [ 'TableOptimizerRun$metrics' => 'A RunMetrics
object containing metrics for the optimizer run.
In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
', ], ], 'S3CatalogDeltaSource' => [ 'base' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogDeltaSource' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', ], ], 'S3CatalogHudiSource' => [ 'base' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog. The Hudi data source must be stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogHudiSource' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', ], ], 'S3CatalogSource' => [ 'base' => 'Specifies an Amazon S3 data store in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogSource' => 'Specifies an Amazon S3 data store in the Glue Data Catalog.
', ], ], 'S3CatalogTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogTarget' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', ], ], 'S3CsvSource' => [ 'base' => 'Specifies a command-separated value (CSV) data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CsvSource' => 'Specifies a command-separated value (CSV) data store stored in Amazon S3.
', ], ], 'S3DeltaCatalogTarget' => [ 'base' => 'Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaCatalogTarget' => 'Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
', ], ], 'S3DeltaDirectTarget' => [ 'base' => 'Specifies a target that writes to a Delta Lake data source in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaDirectTarget' => 'Specifies a target that writes to a Delta Lake data source in Amazon S3.
', ], ], 'S3DeltaSource' => [ 'base' => 'Specifies a Delta Lake data source stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaSource' => 'Specifies a Delta Lake data source stored in Amazon S3.
', ], ], 'S3DirectSourceAdditionalOptions' => [ 'base' => 'Specifies additional connection options for the Amazon S3 data store.
', 'refs' => [ 'S3CsvSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3DeltaSource$AdditionalOptions' => 'Specifies additional options for the connector.
', 'S3HudiSource$AdditionalOptions' => 'Specifies additional options for the connector.
', 'S3JsonSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3ParquetSource$AdditionalOptions' => 'Specifies additional connection options.
', ], ], 'S3DirectTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DirectTarget' => 'Specifies a data target that writes to Amazon S3.
', ], ], 'S3Encryption' => [ 'base' => 'Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
', 'refs' => [ 'S3EncryptionList$member' => NULL, ], ], 'S3EncryptionList' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$S3Encryption' => 'The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
', ], ], 'S3EncryptionMode' => [ 'base' => NULL, 'refs' => [ 'S3Encryption$S3EncryptionMode' => 'The encryption mode to use for Amazon S3 data.
', ], ], 'S3GlueParquetTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', 'refs' => [ 'CodeGenConfigurationNode$S3GlueParquetTarget' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', ], ], 'S3HudiCatalogTarget' => [ 'base' => 'Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiCatalogTarget' => 'Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
', ], ], 'S3HudiDirectTarget' => [ 'base' => 'Specifies a target that writes to a Hudi data source in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiDirectTarget' => 'Specifies a target that writes to a Hudi data source in Amazon S3.
', ], ], 'S3HudiSource' => [ 'base' => 'Specifies a Hudi data source stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiSource' => 'Specifies a Hudi data source stored in Amazon S3.
', ], ], 'S3JsonSource' => [ 'base' => 'Specifies a JSON data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3JsonSource' => 'Specifies a JSON data store stored in Amazon S3.
', ], ], 'S3ParquetSource' => [ 'base' => 'Specifies an Apache Parquet data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3ParquetSource' => 'Specifies an Apache Parquet data store stored in Amazon S3.
', ], ], 'S3SourceAdditionalOptions' => [ 'base' => 'Specifies additional connection options for the Amazon S3 data store.
', 'refs' => [ 'GovernedCatalogSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3CatalogSource$AdditionalOptions' => 'Specifies additional connection options.
', ], ], 'S3Target' => [ 'base' => 'Specifies a data store in Amazon Simple Storage Service (Amazon S3).
', 'refs' => [ 'S3TargetList$member' => NULL, ], ], 'S3TargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$S3Targets' => 'Specifies Amazon Simple Storage Service (Amazon S3) targets.
', ], ], 'SampleSizePercentage' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$SampleSize' => 'The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
', 'StartColumnStatisticsTaskRunRequest$SampleSize' => 'The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
', ], ], 'ScalaCode' => [ 'base' => NULL, 'refs' => [ 'CreateScriptResponse$ScalaCode' => 'The Scala code generated from the DAG.
', 'GetPlanResponse$ScalaCode' => 'The Scala code to perform the mapping.
', ], ], 'Schedule' => [ 'base' => 'A scheduling object using a cron
statement to schedule an event.
For scheduled crawlers, the schedule when the crawler runs.
', ], ], 'ScheduleState' => [ 'base' => NULL, 'refs' => [ 'Schedule$State' => 'The state of the schedule.
', ], ], 'SchedulerNotRunningException' => [ 'base' => 'The specified scheduler is not running.
', 'refs' => [], ], 'SchedulerRunningException' => [ 'base' => 'The specified scheduler is already running.
', 'refs' => [], ], 'SchedulerTransitioningException' => [ 'base' => 'The specified scheduler is transitioning.
', 'refs' => [], ], 'SchemaChangePolicy' => [ 'base' => 'A policy that specifies update and deletion behaviors for the crawler.
', 'refs' => [ 'Crawler$SchemaChangePolicy' => 'The policy that specifies update and delete behaviors for the crawler.
', 'CreateCrawlerRequest$SchemaChangePolicy' => 'The policy for the crawler\'s update and deletion behavior.
', 'UpdateCrawlerRequest$SchemaChangePolicy' => 'The policy for the crawler\'s update and deletion behavior.
', ], ], 'SchemaCheckpointNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$SchemaCheckpoint' => 'The version number of the checkpoint (the last time the compatibility mode was changed).
', 'GetSchemaResponse$SchemaCheckpoint' => 'The version number of the checkpoint (the last time the compatibility mode was changed).
', ], ], 'SchemaColumn' => [ 'base' => 'A key-value pair representing a column and data type that this transform can run against. The Schema
parameter of the MLTransform
may contain up to 100 of these structures.
The difference between schemas as a string in JsonPatch format.
', ], ], 'SchemaDefinitionString' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityInput$SchemaDefinition' => 'The definition of the schema that has to be validated.
', 'CreateSchemaInput$SchemaDefinition' => 'The schema definition using the DataFormat
setting for SchemaName
.
The definition of the schema for which schema details are required.
', 'GetSchemaVersionResponse$SchemaDefinition' => 'The schema definition for the schema ID.
', 'RegisterSchemaVersionInput$SchemaDefinition' => 'The schema definition using the DataFormat
setting for the SchemaName
.
Refers to SYNTAX_DIFF
, which is the currently supported diff type.
The unique ID of the schema in the Glue schema registry.
', 'refs' => [ 'DeleteSchemaInput$SchemaId' => 'This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'DeleteSchemaVersionsInput$SchemaId' => 'This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'GetSchemaByDefinitionInput$SchemaId' => 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn
or SchemaName
has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn
or SchemaName
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn
or SchemaName
has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn
or SchemaName
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
The unique ID for the schema.
', 'QuerySchemaVersionMetadataInput$SchemaId' => 'A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'RegisterSchemaVersionInput$SchemaId' => 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'SchemaReference$SchemaId' => 'A structure that contains schema identity fields. Either this or the SchemaVersionId
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn
or SchemaName
has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn
or SchemaName
has to be provided.
An array of SchemaListItem
objects containing details of each schema.
An object that contains minimal details for a schema.
', 'refs' => [ 'SchemaListDefinition$member' => NULL, ], ], 'SchemaPathString' => [ 'base' => NULL, 'refs' => [ 'MappingEntry$SourcePath' => 'The source path.
', 'MappingEntry$TargetPath' => 'The target path.
', ], ], 'SchemaReference' => [ 'base' => 'An object that references a schema stored in the Glue Schema Registry.
', 'refs' => [ 'StorageDescriptor$SchemaReference' => 'An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
', ], ], 'SchemaRegistryNameString' => [ 'base' => NULL, 'refs' => [ 'CreateRegistryInput$RegistryName' => 'Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
', 'CreateRegistryResponse$RegistryName' => 'The name of the registry.
', 'CreateSchemaInput$SchemaName' => 'Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
', 'CreateSchemaResponse$RegistryName' => 'The name of the registry.
', 'CreateSchemaResponse$SchemaName' => 'The name of the schema.
', 'DeleteRegistryResponse$RegistryName' => 'The name of the registry being deleted.
', 'DeleteSchemaResponse$SchemaName' => 'The name of the schema being deleted.
', 'GetRegistryResponse$RegistryName' => 'The name of the registry.
', 'GetSchemaResponse$RegistryName' => 'The name of the registry.
', 'GetSchemaResponse$SchemaName' => 'The name of the schema.
', 'PutSchemaVersionMetadataResponse$SchemaName' => 'The name for the schema.
', 'PutSchemaVersionMetadataResponse$RegistryName' => 'The name for the registry.
', 'RegistryId$RegistryName' => 'Name of the registry. Used only for lookup. One of RegistryArn
or RegistryName
has to be provided.
The name of the registry.
', 'RemoveSchemaVersionMetadataResponse$SchemaName' => 'The name of the schema.
', 'RemoveSchemaVersionMetadataResponse$RegistryName' => 'The name of the registry.
', 'SchemaId$SchemaName' => 'The name of the schema. One of SchemaArn
or SchemaName
has to be provided.
The name of the schema registry that contains the schema.
', 'SchemaListItem$RegistryName' => 'the name of the registry where the schema resides.
', 'SchemaListItem$SchemaName' => 'The name of the schema.
', 'UpdateRegistryResponse$RegistryName' => 'The name of the updated registry.
', 'UpdateSchemaResponse$SchemaName' => 'The name of the schema.
', 'UpdateSchemaResponse$RegistryName' => 'The name of the registry that contains the schema.
', ], ], 'SchemaRegistryTokenString' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListRegistriesResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'ListSchemaVersionsInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListSchemaVersionsResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'ListSchemasInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListSchemasResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'QuerySchemaVersionMetadataInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'QuerySchemaVersionMetadataResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', ], ], 'SchemaStatus' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$SchemaStatus' => 'The status of the schema.
', 'DeleteSchemaResponse$Status' => 'The status of the schema.
', 'GetSchemaResponse$SchemaStatus' => 'The status of the schema.
', 'SchemaListItem$SchemaStatus' => 'The status of the schema.
', ], ], 'SchemaValidationError' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityResponse$Error' => 'A validation failure error message.
', ], ], 'SchemaVersionErrorItem' => [ 'base' => 'An object that contains the error details for an operation on a schema version.
', 'refs' => [ 'SchemaVersionErrorList$member' => NULL, ], ], 'SchemaVersionErrorList' => [ 'base' => NULL, 'refs' => [ 'DeleteSchemaVersionsResponse$SchemaVersionErrors' => 'A list of SchemaVersionErrorItem
objects, each containing an error and schema version.
The unique identifier of the first schema version.
', 'GetSchemaByDefinitionResponse$SchemaVersionId' => 'The schema ID of the schema version.
', 'GetSchemaVersionInput$SchemaVersionId' => 'The SchemaVersionId
of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId
wrapper has to be provided.
The SchemaVersionId
of the schema version.
The unique version ID of the schema version.
', 'PutSchemaVersionMetadataResponse$SchemaVersionId' => 'The unique version ID of the schema version.
', 'QuerySchemaVersionMetadataInput$SchemaVersionId' => 'The unique version ID of the schema version.
', 'QuerySchemaVersionMetadataResponse$SchemaVersionId' => 'The unique version ID of the schema version.
', 'RegisterSchemaVersionResponse$SchemaVersionId' => 'The unique ID that represents the version of this schema.
', 'RemoveSchemaVersionMetadataInput$SchemaVersionId' => 'The unique version ID of the schema version.
', 'RemoveSchemaVersionMetadataResponse$SchemaVersionId' => 'The version ID for the schema version.
', 'SchemaReference$SchemaVersionId' => 'The unique ID assigned to a version of the schema. Either this or the SchemaId
has to be provided.
The unique identifier of the schema version.
', ], ], 'SchemaVersionList' => [ 'base' => NULL, 'refs' => [ 'ListSchemaVersionsResponse$Schemas' => 'An array of SchemaVersionList
objects containing details of each schema version.
An object containing the details about a schema version.
', 'refs' => [ 'SchemaVersionList$member' => NULL, ], ], 'SchemaVersionNumber' => [ 'base' => 'A structure containing the schema version information.
', 'refs' => [ 'GetSchemaVersionInput$SchemaVersionNumber' => 'The version number of the schema.
', 'GetSchemaVersionsDiffInput$FirstSchemaVersionNumber' => 'The first of the two schema versions to be compared.
', 'GetSchemaVersionsDiffInput$SecondSchemaVersionNumber' => 'The second of the two schema versions to be compared.
', 'PutSchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'QuerySchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'RemoveSchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'UpdateSchemaInput$SchemaVersionNumber' => 'Version number required for check pointing. One of VersionNumber
or Compatibility
has to be provided.
The status of the first schema version created.
', 'GetSchemaByDefinitionResponse$Status' => 'The status of the schema version.
', 'GetSchemaVersionResponse$Status' => 'The status of the schema version.
', 'RegisterSchemaVersionResponse$Status' => 'The status of the schema version.
', 'SchemaVersionListItem$Status' => 'The status of the schema version.
', ], ], 'ScriptLocationString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$ScriptLocation' => 'Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
', ], ], 'SearchPropertyPredicates' => [ 'base' => NULL, 'refs' => [ 'SearchTablesRequest$Filters' => 'A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator
member of the PropertyPredicate
struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name
, a fuzzy match algorithm is used. The Key
field (for example, the value of the Name
field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value
member of PropertyPredicate
. For example, if Key=Name
and Value=link
, tables named customer-link
and xx-link-yy
are returned, but xxlinkyy
is not returned.
The secret manager ARN to store credentials.
', 'AuthenticationConfigurationInput$SecretArn' => 'The secret manager ARN to store credentials in the CreateConnection request.
', ], ], 'SecurityConfiguration' => [ 'base' => 'Specifies a security configuration.
', 'refs' => [ 'GetSecurityConfigurationResponse$SecurityConfiguration' => 'The requested security configuration.
', 'SecurityConfigurationList$member' => NULL, ], ], 'SecurityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'GetSecurityConfigurationsResponse$SecurityConfigurations' => 'A list of security configurations.
', ], ], 'SecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'PhysicalConnectionRequirements$SecurityGroupIdList' => 'The security group ID list used by the connection.
', ], ], 'Segment' => [ 'base' => 'Defines a non-overlapping region of a table\'s partitions, allowing multiple requests to be run in parallel.
', 'refs' => [ 'GetPartitionsRequest$Segment' => 'The segment of the table\'s partitions to scan in this request.
', 'GetUnfilteredPartitionsMetadataRequest$Segment' => 'The segment of the table\'s partitions to scan in this request.
', ], ], 'SelectFields' => [ 'base' => 'Specifies a transform that chooses the data property keys that you want to keep.
', 'refs' => [ 'CodeGenConfigurationNode$SelectFields' => 'Specifies a transform that chooses the data property keys that you want to keep.
', ], ], 'SelectFromCollection' => [ 'base' => 'Specifies a transform that chooses one DynamicFrame
from a collection of DynamicFrames
. The output is the selected DynamicFrame
Specifies a transform that chooses one DynamicFrame
from a collection of DynamicFrames
. The output is the selected DynamicFrame
Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
', ], ], 'SerDeInfo' => [ 'base' => 'Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
', 'refs' => [ 'StorageDescriptor$SerdeInfo' => 'The serialization/deserialization (SerDe) information.
', ], ], 'Session' => [ 'base' => 'The period in which a remote Spark runtime environment is running.
', 'refs' => [ 'CreateSessionResponse$Session' => 'Returns the session object in the response.
', 'GetSessionResponse$Session' => 'The session object is returned in the response.
', 'SessionList$member' => NULL, ], ], 'SessionCommand' => [ 'base' => 'The SessionCommand
that runs the job.
The SessionCommand
that runs the job.
The command object.See SessionCommand.
', ], ], 'SessionIdList' => [ 'base' => NULL, 'refs' => [ 'ListSessionsResponse$Ids' => 'Returns the ID of the session.
', ], ], 'SessionList' => [ 'base' => NULL, 'refs' => [ 'ListSessionsResponse$Sessions' => 'Returns the session object.
', ], ], 'SessionStatus' => [ 'base' => NULL, 'refs' => [ 'Session$Status' => 'The session status.
', ], ], 'SkewedInfo' => [ 'base' => 'Specifies skewed values in a table. Skewed values are those that occur with very high frequency.
', 'refs' => [ 'StorageDescriptor$SkewedInfo' => 'The information about values that appear frequently in a column (skewed values).
', ], ], 'SnowflakeNodeData' => [ 'base' => 'Specifies configuration for Snowflake nodes in Glue Studio.
', 'refs' => [ 'SnowflakeSource$Data' => 'Configuration for the Snowflake data source.
', 'SnowflakeTarget$Data' => 'Specifies the data of the Snowflake target node.
', ], ], 'SnowflakeSource' => [ 'base' => 'Specifies a Snowflake data source.
', 'refs' => [ 'CodeGenConfigurationNode$SnowflakeSource' => 'Specifies a Snowflake data source.
', ], ], 'SnowflakeTarget' => [ 'base' => 'Specifies a Snowflake target.
', 'refs' => [ 'CodeGenConfigurationNode$SnowflakeTarget' => 'Specifies a target that writes to a Snowflake data source.
', ], ], 'Sort' => [ 'base' => NULL, 'refs' => [ 'SortCriterion$Sort' => 'An ascending or descending sort.
', ], ], 'SortCriteria' => [ 'base' => NULL, 'refs' => [ 'SearchTablesRequest$SortCriteria' => 'A list of criteria for sorting the results by a field name, in an ascending or descending order.
', ], ], 'SortCriterion' => [ 'base' => 'Specifies a field to sort by and a sort order.
', 'refs' => [ 'SortCriteria$member' => NULL, ], ], 'SortDirectionType' => [ 'base' => NULL, 'refs' => [ 'TaskRunSortCriteria$SortDirection' => 'The sort direction to be used to sort the list of task runs for the machine learning transform.
', 'TransformSortCriteria$SortDirection' => 'The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
', ], ], 'SourceControlAuthStrategy' => [ 'base' => NULL, 'refs' => [ 'SourceControlDetails$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', 'UpdateJobFromSourceControlRequest$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', 'UpdateSourceControlFromJobRequest$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', ], ], 'SourceControlDetails' => [ 'base' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'refs' => [ 'CreateJobRequest$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'Job$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'JobUpdate$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', ], ], 'SourceControlProvider' => [ 'base' => NULL, 'refs' => [ 'SourceControlDetails$Provider' => 'The provider for the remote repository.
', 'UpdateJobFromSourceControlRequest$Provider' => 'The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.
', 'UpdateSourceControlFromJobRequest$Provider' => 'The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.
', ], ], 'SparkConnectorSource' => [ 'base' => 'Specifies a connector to an Apache Spark data source.
', 'refs' => [ 'CodeGenConfigurationNode$SparkConnectorSource' => 'Specifies a connector to an Apache Spark data source.
', ], ], 'SparkConnectorTarget' => [ 'base' => 'Specifies a target that uses an Apache Spark connector.
', 'refs' => [ 'CodeGenConfigurationNode$SparkConnectorTarget' => 'Specifies a target that uses an Apache Spark connector.
', ], ], 'SparkSQL' => [ 'base' => 'Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame
.
Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame
.
Specifies a transform that writes samples of the data to an Amazon S3 bucket.
', 'refs' => [ 'CodeGenConfigurationNode$Spigot' => 'Specifies a transform that writes samples of the data to an Amazon S3 bucket.
', ], ], 'SplitFields' => [ 'base' => 'Specifies a transform that splits data property keys into two DynamicFrames
. The output is a collection of DynamicFrames
: one with selected data property keys, and one with the remaining data property keys.
Specifies a transform that splits data property keys into two DynamicFrames
. The output is a collection of DynamicFrames
: one with selected data property keys, and one with the remaining data property keys.
Represents a single entry in the list of values for SqlAliases
.
A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify From
as MyDataSource, and Alias
as SqlName, then in your SQL you can do:
select * from SqlName
and that gets data from MyDataSource.
', ], ], 'SqlQuery' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorSource$Query' => 'The table or SQL query to get the data from. You can specify either ConnectionTable
or query
, but not both.
A SQL query that must use Spark SQL syntax and return a single data set.
', ], ], 'StartBlueprintRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartBlueprintRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartColumnStatisticsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartColumnStatisticsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartExportLabelsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartExportLabelsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartImportLabelsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartImportLabelsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartJobRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartJobRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMLEvaluationTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMLEvaluationTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMLLabelingSetGenerationTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMLLabelingSetGenerationTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartingEventBatchCondition' => [ 'base' => 'The batch condition that started the workflow run. Either the number of events in the batch size arrived, in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow member is non-zero.
', 'refs' => [ 'WorkflowRun$StartingEventBatchCondition' => 'The batch condition that started the workflow run.
', ], ], 'StartingPosition' => [ 'base' => NULL, 'refs' => [ 'KinesisStreamingSourceOptions$StartingPosition' => 'The starting position in the Kinesis data stream to read data from. The possible values are "latest"
, "trim_horizon"
, "earliest"
, or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ
(where Z
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest"
.
Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
', ], ], 'Statement' => [ 'base' => 'The statement or request for a particular action to occur in a session.
', 'refs' => [ 'GetStatementResponse$Statement' => 'Returns the statement.
', 'StatementList$member' => NULL, ], ], 'StatementList' => [ 'base' => NULL, 'refs' => [ 'ListStatementsResponse$Statements' => 'Returns the list of statements.
', ], ], 'StatementOutput' => [ 'base' => 'The code execution output in JSON format.
', 'refs' => [ 'Statement$Output' => 'The output in JSON.
', ], ], 'StatementOutputData' => [ 'base' => 'The code execution output in JSON format.
', 'refs' => [ 'StatementOutput$Data' => 'The code execution output.
', ], ], 'StatementState' => [ 'base' => NULL, 'refs' => [ 'Statement$State' => 'The state while request is actioned.
', 'StatementOutput$Status' => 'The status of the code execution output.
', ], ], 'StopColumnStatisticsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopColumnStatisticsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StorageDescriptor' => [ 'base' => 'Describes the physical storage of table data.
', 'refs' => [ 'Partition$StorageDescriptor' => 'Provides information about the physical location where the partition is stored.
', 'PartitionInput$StorageDescriptor' => 'Provides information about the physical location where the partition is stored.
', 'Table$StorageDescriptor' => 'A storage descriptor containing information about the physical storage of this table.
', 'TableInput$StorageDescriptor' => 'A storage descriptor containing information about the physical storage of this table.
', ], ], 'StreamingDataPreviewOptions' => [ 'base' => 'Specifies options related to data preview for viewing a sample of your data.
', 'refs' => [ 'CatalogKafkaSource$DataPreviewOptions' => 'Specifies options related to data preview for viewing a sample of your data.
', 'CatalogKinesisSource$DataPreviewOptions' => 'Additional options for data preview.
', 'DirectKafkaSource$DataPreviewOptions' => 'Specifies options related to data preview for viewing a sample of your data.
', 'DirectKinesisSource$DataPreviewOptions' => 'Additional options for data preview.
', ], ], 'StringColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for character sequence data values.
', 'refs' => [ 'ColumnStatisticsData$StringColumnStatisticsData' => 'String column statistics data.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$SecurityGroupIds' => 'Security group IDs for the security groups to be used by the new DevEndpoint
.
The security groups assigned to the new DevEndpoint
.
A list of security group identifiers used in this DevEndpoint
.
The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint
.
A structure specifying the dialect and dialect version used by the query engine.
', 'refs' => [ 'GetUnfilteredTableMetadataRequest$SupportedDialect' => 'A structure specifying the dialect and dialect version used by the query engine.
', ], ], 'Table' => [ 'base' => 'Represents a collection of related data organized in columns and rows.
', 'refs' => [ 'GetTableResponse$Table' => 'The Table
object that defines the specified table.
A Table object containing the table metadata.
', 'TableList$member' => NULL, 'TableVersion$Table' => 'The table in question.
', ], ], 'TableError' => [ 'base' => 'An error record for table operations.
', 'refs' => [ 'TableErrors$member' => NULL, ], ], 'TableErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableResponse$Errors' => 'A list of errors encountered in attempting to delete the specified tables.
', ], ], 'TableIdentifier' => [ 'base' => 'A structure that describes a target table for resource linking.
', 'refs' => [ 'Table$TargetTable' => 'A TableIdentifier
structure that describes a target table for resource linking.
A TableIdentifier
structure that describes a target table for resource linking.
A structure used to define a table.
', 'refs' => [ 'CreateTableRequest$TableInput' => 'The TableInput
object that defines the metadata table to create in the catalog.
An updated TableInput
object to define the metadata table in the catalog.
A list of the requested Table
objects.
A list of the requested Table
objects. The SearchTables
response returns only the tables that you have access to.
The name of the table for which column statistics is generated.
', 'MappingEntry$SourceTable' => 'The name of the source table.
', 'MappingEntry$TargetTable' => 'The target table.
', ], ], 'TableOptimizer' => [ 'base' => 'Contains details about an optimizer associated with a table.
', 'refs' => [ 'BatchTableOptimizer$tableOptimizer' => 'A TableOptimizer
object that contains details on the configuration and last run of a table optimzer.
The optimizer associated with the specified table.
', ], ], 'TableOptimizerConfiguration' => [ 'base' => 'Contains details on the configuration of a table optimizer. You pass this configuration when creating or updating a table optimizer.
', 'refs' => [ 'CreateTableOptimizerRequest$TableOptimizerConfiguration' => 'A TableOptimizerConfiguration
object representing the configuration of a table optimizer.
A TableOptimizerConfiguration
object that was specified when creating or updating a table optimizer.
A TableOptimizerConfiguration
object representing the configuration of a table optimizer.
An event type representing the status of the table optimizer run.
', ], ], 'TableOptimizerRun' => [ 'base' => 'Contains details for a table optimizer run.
', 'refs' => [ 'TableOptimizer$lastRun' => 'A TableOptimizerRun
object representing the last run of the table optimizer.
Represents the epoch timestamp at which the compaction job was started within Lake Formation.
', 'TableOptimizerRun$endTimestamp' => 'Represents the epoch timestamp at which the compaction job ended.
', ], ], 'TableOptimizerRuns' => [ 'base' => NULL, 'refs' => [ 'ListTableOptimizerRunsResponse$TableOptimizerRuns' => 'A list of the optimizer runs associated with a table.
', ], ], 'TableOptimizerType' => [ 'base' => NULL, 'refs' => [ 'BatchGetTableOptimizerEntry$type' => 'The type of table optimizer.
', 'BatchGetTableOptimizerError$type' => 'The type of table optimizer.
', 'CreateTableOptimizerRequest$Type' => 'The type of table optimizer. Currently, the only valid value is compaction
.
The type of table optimizer.
', 'GetTableOptimizerRequest$Type' => 'The type of table optimizer.
', 'ListTableOptimizerRunsRequest$Type' => 'The type of table optimizer. Currently, the only valid value is compaction
.
The type of table optimizer. Currently, the only valid value is compaction
.
The type of table optimizer. Currently, the only valid value is compaction
.
The prefix added to the names of tables that are created.
', 'CreateCrawlerRequest$TablePrefix' => 'The table prefix used for catalog tables that are created.
', 'UpdateCrawlerRequest$TablePrefix' => 'The table prefix used for catalog tables that are created.
', ], ], 'TableTypeString' => [ 'base' => NULL, 'refs' => [ 'Table$TableType' => 'The type of this table. Glue will create tables with the EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED
.
The type of this table. Glue will create tables with the EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED
.
Specifies a version of a table.
', 'refs' => [ 'GetTableVersionResponse$TableVersion' => 'The requested table version.
', 'GetTableVersionsList$member' => NULL, ], ], 'TableVersionError' => [ 'base' => 'An error record for table-version operations.
', 'refs' => [ 'TableVersionErrors$member' => NULL, ], ], 'TableVersionErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionResponse$Errors' => 'A list of errors encountered while trying to delete the specified table versions.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeysList$member' => NULL, 'TagsMap$key' => NULL, ], ], 'TagKeysList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagsToRemove' => 'Tags to remove from this resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagsMap$value' => NULL, ], ], 'TagsMap' => [ 'base' => NULL, 'refs' => [ 'CreateBlueprintRequest$Tags' => 'The tags to be applied to this blueprint.
', 'CreateConnectionRequest$Tags' => 'The tags you assign to the connection.
', 'CreateCrawlerRequest$Tags' => 'The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateCustomEntityTypeRequest$Tags' => 'A list of tags applied to the custom entity type.
', 'CreateDataQualityRulesetRequest$Tags' => 'A list of tags applied to the data quality ruleset.
', 'CreateDatabaseRequest$Tags' => 'The tags you assign to the database.
', 'CreateDevEndpointRequest$Tags' => 'The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateJobRequest$Tags' => 'The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateMLTransformRequest$Tags' => 'The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateRegistryInput$Tags' => 'Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
', 'CreateRegistryResponse$Tags' => 'The tags for the registry.
', 'CreateSchemaInput$Tags' => 'Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
', 'CreateSchemaResponse$Tags' => 'The tags for the schema.
', 'CreateSessionRequest$Tags' => 'The map of key value pairs (tags) belonging to the session.
', 'CreateTriggerRequest$Tags' => 'The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateUsageProfileRequest$Tags' => 'A list of tags applied to the usage profile.
', 'CreateWorkflowRequest$Tags' => 'The tags to be used with this workflow.
', 'GetTagsResponse$Tags' => 'The requested tags.
', 'ListBlueprintsRequest$Tags' => 'Filters the list by an Amazon Web Services resource tag.
', 'ListCrawlersRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListCustomEntityTypesRequest$Tags' => 'A list of key-value pair tags.
', 'ListDataQualityRulesetsRequest$Tags' => 'A list of key-value pair tags.
', 'ListDevEndpointsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListJobsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListMLTransformsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListSessionsRequest$Tags' => 'Tags belonging to the session.
', 'ListTriggersRequest$Tags' => 'Specifies to return only these tagged resources.
', 'TagResourceRequest$TagsToAdd' => 'Tags to add to this resource.
', ], ], 'TargetFormat' => [ 'base' => NULL, 'refs' => [ 'S3DeltaDirectTarget$Format' => 'Specifies the data output format for the target.
', 'S3DirectTarget$Format' => 'Specifies the data output format for the target.
', 'S3HudiDirectTarget$Format' => 'Specifies the data output format for the target.
', ], ], 'TaskRun' => [ 'base' => 'The sampling parameters that are associated with the machine learning transform.
', 'refs' => [ 'TaskRunList$member' => NULL, ], ], 'TaskRunFilterCriteria' => [ 'base' => 'The criteria that are used to filter the task runs for the machine learning transform.
', 'refs' => [ 'GetMLTaskRunsRequest$Filter' => 'The filter criteria, in the TaskRunFilterCriteria
structure, for the task run.
A list of task runs that are associated with the transform.
', ], ], 'TaskRunProperties' => [ 'base' => 'The configuration properties for the task run.
', 'refs' => [ 'GetMLTaskRunResponse$Properties' => 'The list of properties that are associated with the task run.
', 'TaskRun$Properties' => 'Specifies configuration properties associated with this task run.
', ], ], 'TaskRunSortColumnType' => [ 'base' => NULL, 'refs' => [ 'TaskRunSortCriteria$Column' => 'The column to be used to sort the list of task runs for the machine learning transform.
', ], ], 'TaskRunSortCriteria' => [ 'base' => 'The sorting criteria that are used to sort the list of task runs for the machine learning transform.
', 'refs' => [ 'GetMLTaskRunsRequest$Sort' => 'The sorting criteria, in the TaskRunSortCriteria
structure, for the task run.
The status for this run.
', 'DataQualityRuleRecommendationRunDescription$Status' => 'The status for this run.
', 'DataQualityRulesetEvaluationRunDescription$Status' => 'The status for this run.
', 'GetDataQualityRuleRecommendationRunResponse$Status' => 'The status for this run.
', 'GetDataQualityRulesetEvaluationRunResponse$Status' => 'The status for this run.
', 'GetMLTaskRunResponse$Status' => 'The status for this task run.
', 'TaskRun$Status' => 'The current status of the requested task run.
', 'TaskRunFilterCriteria$Status' => 'The current status of the task run.
', ], ], 'TaskType' => [ 'base' => NULL, 'refs' => [ 'TaskRunFilterCriteria$TaskRunType' => 'The type of task run.
', 'TaskRunProperties$TaskType' => 'The type of task run.
', ], ], 'Timeout' => [ 'base' => NULL, 'refs' => [ 'Action$Timeout' => 'The JobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'CreateMLTransformRequest$Timeout' => 'The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation for other job types.
', 'CreateSessionRequest$IdleTimeout' => 'The number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types.
', 'GetDataQualityRuleRecommendationRunResponse$Timeout' => 'The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'JobRun$Timeout' => 'The JobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'JobUpdate$Timeout' => 'The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'MLTransform$Timeout' => 'The timeout in minutes of the machine learning transform.
', 'StartDataQualityRuleRecommendationRunRequest$Timeout' => 'The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The JobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'UpdateMLTransformRequest$Timeout' => 'The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The time that the migration was started.
', 'ColumnStatistics$AnalyzedTime' => 'The timestamp of when column statistics were generated.
', 'ColumnStatisticsTaskRun$CreationTime' => 'The time that this task was created.
', 'ColumnStatisticsTaskRun$LastUpdated' => 'The last point in time when this task was modified.
', 'ColumnStatisticsTaskRun$StartTime' => 'The start time of the task.
', 'ColumnStatisticsTaskRun$EndTime' => 'The end time of the task.
', 'Connection$CreationTime' => 'The timestamp of the time that this connection definition was created.
', 'Connection$LastUpdatedTime' => 'The timestamp of the last time the connection definition was updated.
', 'Connection$LastConnectionValidationTime' => 'A timestamp of the time this connection was last validated.
', 'Crawler$CreationTime' => 'The time that the crawler was created.
', 'Crawler$LastUpdated' => 'The time that the crawler was last updated.
', 'CrawlerHistory$StartTime' => 'The date and time on which the crawl started.
', 'CrawlerHistory$EndTime' => 'The date and time on which the crawl ended.
', 'CsvClassifier$CreationTime' => 'The time that this classifier was registered.
', 'CsvClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'DataQualityResult$StartedOn' => 'The date and time when this data quality run started.
', 'DataQualityResult$CompletedOn' => 'The date and time when this data quality run completed.
', 'DataQualityResultDescription$StartedOn' => 'The time that the run started for this data quality result.
', 'DataQualityResultFilterCriteria$StartedAfter' => 'Filter results by runs that started after this time.
', 'DataQualityResultFilterCriteria$StartedBefore' => 'Filter results by runs that started before this time.
', 'DataQualityRuleRecommendationRunDescription$StartedOn' => 'The date and time when this run started.
', 'DataQualityRuleRecommendationRunFilter$StartedBefore' => 'Filter based on time for results started before provided time.
', 'DataQualityRuleRecommendationRunFilter$StartedAfter' => 'Filter based on time for results started after provided time.
', 'DataQualityRulesetEvaluationRunDescription$StartedOn' => 'The date and time when the run started.
', 'DataQualityRulesetEvaluationRunFilter$StartedBefore' => 'Filter results by runs that started before this time.
', 'DataQualityRulesetEvaluationRunFilter$StartedAfter' => 'Filter results by runs that started after this time.
', 'DataQualityRulesetFilterCriteria$CreatedBefore' => 'Filter on rulesets created before this date.
', 'DataQualityRulesetFilterCriteria$CreatedAfter' => 'Filter on rulesets created after this date.
', 'DataQualityRulesetFilterCriteria$LastModifiedBefore' => 'Filter on rulesets last modified before this date.
', 'DataQualityRulesetFilterCriteria$LastModifiedAfter' => 'Filter on rulesets last modified after this date.
', 'DataQualityRulesetListDetails$CreatedOn' => 'The date and time the data quality ruleset was created.
', 'DataQualityRulesetListDetails$LastModifiedOn' => 'The date and time the data quality ruleset was last modified.
', 'Database$CreateTime' => 'The time at which the metadata database was created in the catalog.
', 'DateColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DateColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', 'GetDataQualityResultResponse$StartedOn' => 'The date and time when the run for this data quality result started.
', 'GetDataQualityResultResponse$CompletedOn' => 'The date and time when the run for this data quality result was completed.
', 'GetDataQualityRuleRecommendationRunResponse$StartedOn' => 'The date and time when this run started.
', 'GetDataQualityRuleRecommendationRunResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality rule recommendation run was modified.
', 'GetDataQualityRuleRecommendationRunResponse$CompletedOn' => 'The date and time when this run was completed.
', 'GetDataQualityRulesetEvaluationRunResponse$StartedOn' => 'The date and time when this run started.
', 'GetDataQualityRulesetEvaluationRunResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality rule recommendation run was modified.
', 'GetDataQualityRulesetEvaluationRunResponse$CompletedOn' => 'The date and time when this run was completed.
', 'GetDataQualityRulesetResponse$CreatedOn' => 'A timestamp. The time and date that this data quality ruleset was created.
', 'GetDataQualityRulesetResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality ruleset was modified.
', 'GetMLTaskRunResponse$StartedOn' => 'The date and time when this task run started.
', 'GetMLTaskRunResponse$LastModifiedOn' => 'The date and time when this task run was last modified.
', 'GetMLTaskRunResponse$CompletedOn' => 'The date and time when this task run was completed.
', 'GetMLTransformResponse$CreatedOn' => 'The date and time when the transform was created.
', 'GetMLTransformResponse$LastModifiedOn' => 'The date and time when the transform was last modified.
', 'GetPartitionsRequest$QueryAsOfTime' => 'The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId
.
The date and time at which the policy was created.
', 'GetResourcePolicyResponse$UpdateTime' => 'The date and time at which the policy was last updated.
', 'GetTableRequest$QueryAsOfTime' => 'The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId
.
The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId
.
The date and time at which the policy was created.
', 'GluePolicy$UpdateTime' => 'The date and time at which the policy was last updated.
', 'GrokClassifier$CreationTime' => 'The time that this classifier was registered.
', 'GrokClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'JsonClassifier$CreationTime' => 'The time that this classifier was registered.
', 'JsonClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'LastCrawlInfo$StartTime' => 'The time at which the crawl started.
', 'MLTransform$CreatedOn' => 'A timestamp. The time and date that this machine learning transform was created.
', 'MLTransform$LastModifiedOn' => 'A timestamp. The last point in time when this machine learning transform was modified.
', 'Partition$CreationTime' => 'The time at which the partition was created.
', 'Partition$LastAccessTime' => 'The last time at which the partition was accessed.
', 'Partition$LastAnalyzedTime' => 'The last time at which column statistics were computed for this partition.
', 'PartitionInput$LastAccessTime' => 'The last time at which the partition was accessed.
', 'PartitionInput$LastAnalyzedTime' => 'The last time at which column statistics were computed for this partition.
', 'QuerySessionContext$QueryStartTime' => 'A timestamp provided by the query engine for when the query started.
', 'Table$CreateTime' => 'The time when the table definition was created in the Data Catalog.
', 'Table$UpdateTime' => 'The last time that the table was updated.
', 'Table$LastAccessTime' => 'The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
', 'Table$LastAnalyzedTime' => 'The last time that column statistics were computed for this table.
', 'TableInput$LastAccessTime' => 'The last time that the table was accessed.
', 'TableInput$LastAnalyzedTime' => 'The last time that column statistics were computed for this table.
', 'TaskRun$StartedOn' => 'The date and time that this task run started.
', 'TaskRun$LastModifiedOn' => 'The last point in time that the requested task run was updated.
', 'TaskRun$CompletedOn' => 'The last point in time that the requested task run was completed.
', 'TaskRunFilterCriteria$StartedBefore' => 'Filter on task runs started before this date.
', 'TaskRunFilterCriteria$StartedAfter' => 'Filter on task runs started after this date.
', 'TransformFilterCriteria$CreatedBefore' => 'The time and date before which the transforms were created.
', 'TransformFilterCriteria$CreatedAfter' => 'The time and date after which the transforms were created.
', 'TransformFilterCriteria$LastModifiedBefore' => 'Filter on transforms last modified before this date.
', 'TransformFilterCriteria$LastModifiedAfter' => 'Filter on transforms last modified after this date.
', 'UserDefinedFunction$CreateTime' => 'The time at which the function was created.
', 'XMLClassifier$CreationTime' => 'The time that this classifier was registered.
', 'XMLClassifier$LastUpdated' => 'The time that this classifier was last updated.
', ], ], 'TimestampValue' => [ 'base' => NULL, 'refs' => [ 'Blueprint$CreatedOn' => 'The date and time the blueprint was registered.
', 'Blueprint$LastModifiedOn' => 'The date and time the blueprint was last modified.
', 'BlueprintRun$StartedOn' => 'The date and time that the blueprint run started.
', 'BlueprintRun$CompletedOn' => 'The date and time that the blueprint run completed.
', 'Crawl$StartedOn' => 'The date and time on which the crawl started.
', 'Crawl$CompletedOn' => 'The date and time on which the crawl completed.
', 'CreateDevEndpointResponse$CreatedTimestamp' => 'The point in time at which this DevEndpoint
was created.
The time at which the new security configuration was created.
', 'DevEndpoint$CreatedTimestamp' => 'The point in time at which this DevEndpoint was created.
', 'DevEndpoint$LastModifiedTimestamp' => 'The point in time at which this DevEndpoint
was last modified.
The date and time when the usage profile was created.
', 'GetUsageProfileResponse$LastModifiedOn' => 'The date and time when the usage profile was last modified.
', 'Job$CreatedOn' => 'The time and date that this job definition was created.
', 'Job$LastModifiedOn' => 'The last point in time when this job definition was modified.
', 'JobRun$StartedOn' => 'The date and time at which this job run was started.
', 'JobRun$LastModifiedOn' => 'The last time that this job run was modified.
', 'JobRun$CompletedOn' => 'The date and time that this job run completed.
', 'LastActiveDefinition$LastModifiedOn' => 'The date and time the blueprint was last modified.
', 'SecurityConfiguration$CreatedTimeStamp' => 'The time at which this security configuration was created.
', 'Session$CreatedOn' => 'The time and date when the session was created.
', 'Session$CompletedOn' => 'The date and time that this session is completed.
', 'UsageProfileDefinition$CreatedOn' => 'The date and time when the usage profile was created.
', 'UsageProfileDefinition$LastModifiedOn' => 'The date and time when the usage profile was last modified.
', 'Workflow$CreatedOn' => 'The date and time when the workflow was created.
', 'Workflow$LastModifiedOn' => 'The date and time when the workflow was last modified.
', 'WorkflowRun$StartedOn' => 'The date and time when the workflow run was started.
', 'WorkflowRun$CompletedOn' => 'The date and time when the workflow run completed.
', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'GetClassifiersRequest$NextToken' => 'An optional continuation token.
', 'GetClassifiersResponse$NextToken' => 'A continuation token.
', 'GetColumnStatisticsTaskRunsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetColumnStatisticsTaskRunsResponse$NextToken' => 'A continuation token, if not all task runs have yet been returned.
', 'GetConnectionsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetConnectionsResponse$NextToken' => 'A continuation token, if the list of connections returned does not include the last of the filtered connections.
', 'GetCrawlerMetricsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetCrawlerMetricsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'GetCrawlersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'GetCrawlersResponse$NextToken' => 'A continuation token, if the returned list has not reached the end of those defined in this customer account.
', 'GetDatabasesRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetDatabasesResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'GetPartitionIndexesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'GetPartitionIndexesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', 'GetPartitionsRequest$NextToken' => 'A continuation token, if this is not the first call to retrieve these partitions.
', 'GetPartitionsResponse$NextToken' => 'A continuation token, if the returned list of partitions does not include the last one.
', 'GetResourcePoliciesRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'GetResourcePoliciesResponse$NextToken' => 'A continuation token, if the returned list does not contain the last resource policy available.
', 'GetTableVersionsRequest$NextToken' => 'A continuation token, if this is not the first call.
', 'GetTableVersionsResponse$NextToken' => 'A continuation token, if the list of available versions does not include the last one.
', 'GetTablesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'GetTablesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', 'GetUnfilteredPartitionsMetadataRequest$NextToken' => 'A continuation token, if this is not the first call to retrieve these partitions.
', 'GetUnfilteredPartitionsMetadataResponse$NextToken' => 'A continuation token, if the returned list of partitions does not include the last one.
', 'GetUserDefinedFunctionsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetUserDefinedFunctionsResponse$NextToken' => 'A continuation token, if the list of functions returned does not include the last requested function.
', 'ListColumnStatisticsTaskRunsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListColumnStatisticsTaskRunsResponse$NextToken' => 'A continuation token, if not all task run IDs have yet been returned.
', 'ListCrawlersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListCrawlersResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListCrawlsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListCrawlsResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'SearchTablesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'SearchTablesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', ], ], 'TokenUrl' => [ 'base' => NULL, 'refs' => [ 'OAuth2Properties$TokenUrl' => 'The URL of the provider\'s authentication server, to exchange an authorization code for an access token.
', 'OAuth2PropertiesInput$TokenUrl' => 'The URL of the provider\'s authentication server, to exchange an authorization code for an access token.
', ], ], 'TokenUrlParameterKey' => [ 'base' => NULL, 'refs' => [ 'TokenUrlParametersMap$key' => NULL, ], ], 'TokenUrlParameterValue' => [ 'base' => NULL, 'refs' => [ 'TokenUrlParametersMap$value' => NULL, ], ], 'TokenUrlParametersMap' => [ 'base' => NULL, 'refs' => [ 'OAuth2Properties$TokenUrlParametersMap' => 'A map of parameters that are added to the token GET
request.
A map of parameters that are added to the token GET
request.
Specifies a number of records to write starting from the beginning of the dataset.
', ], ], 'TotalSegmentsInteger' => [ 'base' => NULL, 'refs' => [ 'Segment$TotalSegments' => 'The total number of segments.
', ], ], 'TransactionIdString' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableRequest$TransactionId' => 'The transaction ID at which to delete the table contents.
', 'CreateTableRequest$TransactionId' => 'The ID of the transaction.
', 'DeleteTableRequest$TransactionId' => 'The transaction ID at which to delete the table contents.
', 'GetPartitionsRequest$TransactionId' => 'The transaction ID at which to read the partition contents.
', 'GetTableRequest$TransactionId' => 'The transaction ID at which to read the table contents.
', 'GetTablesRequest$TransactionId' => 'The transaction ID at which to read the table contents.
', 'UpdateTableRequest$TransactionId' => 'The transaction ID at which to update the table contents.
', ], ], 'TransformConfigParameter' => [ 'base' => 'Specifies the parameters in the config file of the dynamic transform.
', 'refs' => [ 'TransformConfigParameterList$member' => NULL, ], ], 'TransformConfigParameterList' => [ 'base' => NULL, 'refs' => [ 'DynamicTransform$Parameters' => 'Specifies the parameters of the dynamic transform.
', ], ], 'TransformEncryption' => [ 'base' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.
', 'refs' => [ 'CreateMLTransformRequest$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', 'GetMLTransformResponse$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', 'MLTransform$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', ], ], 'TransformFilterCriteria' => [ 'base' => 'The criteria used to filter the machine learning transforms.
', 'refs' => [ 'GetMLTransformsRequest$Filter' => 'The filter transformation criteria.
', 'ListMLTransformsRequest$Filter' => 'A TransformFilterCriteria
used to filter the machine learning transforms.
The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.
', ], ], 'TransformList' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformsResponse$Transforms' => 'A list of machine learning transforms.
', ], ], 'TransformParameters' => [ 'base' => 'The algorithm-specific parameters that are associated with the machine learning transform.
', 'refs' => [ 'CreateMLTransformRequest$Parameters' => 'The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
', 'GetMLTransformResponse$Parameters' => 'The configuration parameters that are specific to the algorithm used.
', 'MLTransform$Parameters' => 'A TransformParameters
object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.
', ], ], 'TransformSchema' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformResponse$Schema' => 'The Map<Column, Type>
object that represents the schema that this transform accepts. Has an upper bound of 100 columns.
A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
', 'TransformFilterCriteria$Schema' => 'Filters on datasets with a specific schema. The Map<Column, Type>
object is an array of key-value pairs representing the schema this transform accepts, where Column
is the name of a column, and Type
is the type of the data such as an integer or string. Has an upper bound of 100 columns.
The column to be used in the sorting criteria that are associated with the machine learning transform.
', ], ], 'TransformSortCriteria' => [ 'base' => 'The sorting criteria that are associated with the machine learning transform.
', 'refs' => [ 'GetMLTransformsRequest$Sort' => 'The sorting criteria.
', 'ListMLTransformsRequest$Sort' => 'A TransformSortCriteria
used to sort the machine learning transforms.
The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
', 'MLTransform$Status' => 'The current status of the machine learning transform.
', 'TransformFilterCriteria$Status' => 'Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
', ], ], 'TransformType' => [ 'base' => NULL, 'refs' => [ 'EvaluationMetrics$TransformType' => 'The type of machine learning transform.
', 'TransformFilterCriteria$TransformType' => 'The type of machine learning transform that is used to filter the machine learning transforms.
', 'TransformParameters$TransformType' => 'The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
', ], ], 'Trigger' => [ 'base' => 'Information about a specific trigger.
', 'refs' => [ 'GetTriggerResponse$Trigger' => 'The requested trigger definition.
', 'TriggerList$member' => NULL, 'TriggerNodeDetails$Trigger' => 'The information of the trigger represented by the trigger node.
', 'UpdateTriggerResponse$Trigger' => 'The resulting trigger definition.
', ], ], 'TriggerList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTriggersResponse$Triggers' => 'A list of trigger definitions.
', 'GetTriggersResponse$Triggers' => 'A list of triggers for the specified job.
', ], ], 'TriggerNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTriggersRequest$TriggerNames' => 'A list of trigger names, which may be the names returned from the ListTriggers
operation.
A list of names of triggers not found.
', 'ListTriggersResponse$TriggerNames' => 'The names of all triggers in the account, or the triggers with the specified tags.
', ], ], 'TriggerNodeDetails' => [ 'base' => 'The details of a Trigger node present in the workflow.
', 'refs' => [ 'Node$TriggerDetails' => 'Details of the Trigger when the node represents a Trigger.
', ], ], 'TriggerState' => [ 'base' => NULL, 'refs' => [ 'Trigger$State' => 'The current state of the trigger.
', ], ], 'TriggerType' => [ 'base' => NULL, 'refs' => [ 'CreateTriggerRequest$Type' => 'The type of the new trigger.
', 'Trigger$Type' => 'The type of trigger that this is.
', ], ], 'TriggerUpdate' => [ 'base' => 'A structure used to provide information used to update a trigger. This object updates the previous trigger definition by overwriting it completely.
', 'refs' => [ 'UpdateTriggerRequest$TriggerUpdate' => 'The new values with which to update the trigger.
', ], ], 'TwoInputs' => [ 'base' => NULL, 'refs' => [ 'Join$Inputs' => 'The data inputs identified by their node names.
', 'Merge$Inputs' => 'The data inputs identified by their node names.
', 'Union$Inputs' => 'The node ID inputs to the transform.
', ], ], 'TypeString' => [ 'base' => NULL, 'refs' => [ 'ColumnStatistics$ColumnType' => 'The data type of the column.
', ], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'Database$LocationUri' => 'The location of the database (for example, an HDFS path).
', 'DatabaseInput$LocationUri' => 'The location of the database (for example, an HDFS path).
', 'ResourceUri$Uri' => 'The URI for accessing the resource.
', ], ], 'UnfilteredPartition' => [ 'base' => 'A partition that contains unfiltered metadata.
', 'refs' => [ 'UnfilteredPartitionList$member' => NULL, ], ], 'UnfilteredPartitionList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredPartitionsMetadataResponse$UnfilteredPartitions' => 'A list of requested partitions.
', ], ], 'Union' => [ 'base' => 'Specifies a transform that combines the rows from two or more datasets into a single result.
', 'refs' => [ 'CodeGenConfigurationNode$Union' => 'Specifies a transform that combines the rows from two or more datasets into a single result.
', ], ], 'UnionType' => [ 'base' => NULL, 'refs' => [ 'Union$UnionType' => 'Indicates the type of Union transform.
Specify ALL
to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.
Specify DISTINCT
to remove duplicate rows in the resulting DynamicFrame.
The update behavior when the crawler finds a changed schema.
', ], ], 'UpdateBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCatalogBehavior' => [ 'base' => NULL, 'refs' => [ 'CatalogSchemaChangePolicy$UpdateBehavior' => 'The update behavior when the crawler finds a changed schema.
', 'DirectSchemaChangePolicy$UpdateBehavior' => 'The update behavior when the crawler finds a changed schema.
', ], ], 'UpdateClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsList' => [ 'base' => NULL, 'refs' => [ 'UpdateColumnStatisticsForPartitionRequest$ColumnStatisticsList' => 'A list of the column statistics.
', 'UpdateColumnStatisticsForTableRequest$ColumnStatisticsList' => 'A list of the column statistics.
', ], ], 'UpdateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCsvClassifierRequest' => [ 'base' => 'Specifies a custom CSV classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$CsvClassifier' => 'A CsvClassifier
object with updated fields.
Specifies a grok classifier to update when passed to UpdateClassifier
.
A GrokClassifier
object with updated fields.
Specifies a JSON classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$JsonClassifier' => 'A JsonClassifier
object with updated fields.
Specifies an XML classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$XMLClassifier' => 'An XMLClassifier
object with updated fields.
The date and time the registry was updated.
', 'GetSchemaResponse$UpdatedTime' => 'The date and time the schema was updated.
', 'RegistryListItem$UpdatedTime' => 'The date the registry was updated.
', 'SchemaListItem$UpdatedTime' => 'The date and time that a schema was updated.
', ], ], 'UpsertRedshiftTargetOptions' => [ 'base' => 'The options to configure an upsert operation when writing to a Redshift target .
', 'refs' => [ 'RedshiftTarget$UpsertRedshiftOptions' => 'The set of options to configure an upsert operation when writing to a Redshift target.
', ], ], 'UriString' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$LogUri' => 'This field is reserved for future use.
', 'DataQualityEvaluationRunAdditionalRunOptions$ResultsS3Prefix' => 'Prefix for Amazon S3 to store results.
', 'ExportLabelsTaskRunProperties$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
', 'ImportLabelsTaskRunProperties$InputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
', 'Job$LogUri' => 'This field is reserved for future use.
', 'JobUpdate$LogUri' => 'This field is reserved for future use.
', 'LabelingSetGenerationTaskRunProperties$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
', 'StartExportLabelsTaskRunRequest$OutputS3Path' => 'The Amazon S3 path where you export the labels.
', 'StartImportLabelsTaskRunRequest$InputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
', 'StartMLLabelingSetGenerationTaskRunRequest$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.
', ], ], 'UsageProfileDefinition' => [ 'base' => 'Describes an Glue usage profile.
', 'refs' => [ 'UsageProfileDefinitionList$member' => NULL, ], ], 'UsageProfileDefinitionList' => [ 'base' => NULL, 'refs' => [ 'ListUsageProfilesResponse$Profiles' => 'A list of usage profile (UsageProfileDefinition
) objects.
Represents the equivalent of a Hive user-defined function (UDF
) definition.
The requested function definition.
', 'UserDefinedFunctionList$member' => NULL, ], ], 'UserDefinedFunctionInput' => [ 'base' => 'A structure used to create or update a user-defined function.
', 'refs' => [ 'CreateUserDefinedFunctionRequest$FunctionInput' => 'A FunctionInput
object that defines the function to create in the Data Catalog.
A FunctionInput
object that redefines the function in the Data Catalog.
A list of requested function definitions.
', ], ], 'UserManagedClientApplicationClientId' => [ 'base' => NULL, 'refs' => [ 'OAuth2ClientApplication$UserManagedClientApplicationClientId' => 'The client application clientID if the ClientAppType is USER_MANAGED
.
A value could not be validated.
', 'refs' => [], ], 'ValueString' => [ 'base' => NULL, 'refs' => [ 'BoundedPartitionValueList$member' => NULL, 'ConnectionProperties$value' => NULL, 'GetUnfilteredPartitionMetadataRequest$Region' => 'Specified only if the base tables belong to a different Amazon Web Services Region.
', 'GetUnfilteredPartitionsMetadataRequest$Region' => 'Specified only if the base tables belong to a different Amazon Web Services Region.
', 'GetUnfilteredTableMetadataRequest$Region' => 'Specified only if the base tables belong to a different Amazon Web Services Region.
', 'PropertyPredicate$Key' => 'The key of the property.
', 'PropertyPredicate$Value' => 'The value of the property.
', 'SearchTablesRequest$SearchText' => 'A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
', 'SortCriterion$FieldName' => 'The name of the field on which to sort.
', 'ValueStringList$member' => NULL, ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'DeleteColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', 'DeletePartitionRequest$PartitionValues' => 'The values that define the partition.
', 'GetColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', 'GetPartitionRequest$PartitionValues' => 'The values that define the partition.
', 'GetUnfilteredPartitionMetadataRequest$PartitionValues' => '(Required) A list of partition key values.
', 'Partition$Values' => 'The values of the partition.
', 'PartitionError$PartitionValues' => 'The values that define the partition.
', 'PartitionInput$Values' => 'The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
', 'PartitionValueList$Values' => 'The list of values.
', 'UpdateColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', ], ], 'VersionId' => [ 'base' => NULL, 'refs' => [ 'Crawler$Version' => 'The version of the crawler.
', 'CsvClassifier$Version' => 'The version of this classifier.
', 'GrokClassifier$Version' => 'The version of this classifier.
', 'JsonClassifier$Version' => 'The version of this classifier.
', 'XMLClassifier$Version' => 'The version of this classifier.
', ], ], 'VersionLongNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$LatestSchemaVersion' => 'The latest version of the schema associated with the returned schema definition.
', 'CreateSchemaResponse$NextSchemaVersion' => 'The next version of the schema associated with the returned schema definition.
', 'GetSchemaResponse$LatestSchemaVersion' => 'The latest version of the schema associated with the returned schema definition.
', 'GetSchemaResponse$NextSchemaVersion' => 'The next version of the schema associated with the returned schema definition.
', 'GetSchemaVersionResponse$VersionNumber' => 'The version number of the schema.
', 'PutSchemaVersionMetadataResponse$VersionNumber' => 'The version number of the schema.
', 'RegisterSchemaVersionResponse$VersionNumber' => 'The version of this schema (for sync flow only, in case this is the first version).
', 'RemoveSchemaVersionMetadataResponse$VersionNumber' => 'The version number of the schema.
', 'SchemaReference$SchemaVersionNumber' => 'The version number of the schema.
', 'SchemaVersionErrorItem$VersionNumber' => 'The version number of the schema.
', 'SchemaVersionListItem$VersionNumber' => 'The version number of the schema.
', 'SchemaVersionNumber$VersionNumber' => 'The version number of the schema.
', ], ], 'VersionMismatchException' => [ 'base' => 'There was a version conflict.
', 'refs' => [], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionList$member' => NULL, 'DeleteTableVersionRequest$VersionId' => 'The ID of the table version to be deleted. A VersionID
is a string representation of an integer. Each version is incremented by 1.
The ID value of the table version to be retrieved. A VersionID
is a string representation of an integer. Each version is incremented by 1.
The table version for the Iceberg table. Defaults to 2.
', 'Table$VersionId' => 'The ID of the table version.
', 'TableVersion$VersionId' => 'The ID value that identifies this table version. A VersionId
is a string representation of an integer. Each version is incremented by 1.
The ID value of the version in question. A VersionID
is a string representation of an integer. Each version is incremented by 1.
The version ID at which to update the table contents.
', ], ], 'VersionsString' => [ 'base' => NULL, 'refs' => [ 'DeleteSchemaVersionsInput$Versions' => 'A version range may be supplied which may be of the format:
a single version number, 5
a range, 5-8 : deletes versions 5, 6, 7, 8
A structure containing details for representations.
', 'refs' => [ 'Table$ViewDefinition' => 'A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
', ], ], 'ViewDefinitionInput' => [ 'base' => 'A structure containing details for creating or updating an Glue view.
', 'refs' => [ 'TableInput$ViewDefinition' => 'A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
', ], ], 'ViewDialect' => [ 'base' => NULL, 'refs' => [ 'SupportedDialect$Dialect' => 'The dialect of the query engine.
', 'ViewRepresentation$Dialect' => 'The dialect of the query engine.
', 'ViewRepresentationInput$Dialect' => 'A parameter that specifies the engine type of a specific representation.
', ], ], 'ViewDialectVersionString' => [ 'base' => NULL, 'refs' => [ 'SupportedDialect$DialectVersion' => 'The version of the dialect of the query engine. For example, 3.0.0.
', 'ViewRepresentation$DialectVersion' => 'The version of the dialect of the query engine. For example, 3.0.0.
', 'ViewRepresentationInput$DialectVersion' => 'A parameter that specifies the version of the engine of a specific representation.
', ], ], 'ViewRepresentation' => [ 'base' => 'A structure that contains the dialect of the view, and the query that defines the view.
', 'refs' => [ 'ViewRepresentationList$member' => NULL, ], ], 'ViewRepresentationInput' => [ 'base' => 'A structure containing details of a representation to update or create a Lake Formation view.
', 'refs' => [ 'ViewRepresentationInputList$member' => NULL, ], ], 'ViewRepresentationInputList' => [ 'base' => NULL, 'refs' => [ 'ViewDefinitionInput$Representations' => 'A list of structures that contains the dialect of the view, and the query that defines the view.
', ], ], 'ViewRepresentationList' => [ 'base' => NULL, 'refs' => [ 'ViewDefinition$Representations' => 'A list of representations.
', ], ], 'ViewSubObjectsList' => [ 'base' => NULL, 'refs' => [ 'ViewDefinition$SubObjects' => 'A list of table Amazon Resource Names (ARNs).
', 'ViewDefinitionInput$SubObjects' => 'A list of base table ARNs that make up the view.
', ], ], 'ViewTextString' => [ 'base' => NULL, 'refs' => [ 'Table$ViewOriginalText' => 'Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW
, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'TableInput$ViewOriginalText' => 'Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW
, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'ViewRepresentation$ViewOriginalText' => 'The SELECT
query provided by the customer during CREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead). ViewOriginalText
is used for cases like SHOW CREATE VIEW
where users want to see the original DDL command that created the view.
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText
to ViewExpandedText
. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
A string that represents the original SQL query that describes the view.
', 'ViewRepresentationInput$ViewExpandedText' => 'A string that represents the SQL query that describes the view with expanded resource ARNs
', ], ], 'ViewUpdateAction' => [ 'base' => NULL, 'refs' => [ 'UpdateTableRequest$ViewUpdateAction' => 'The operation to be performed when updating the view.
', ], ], 'WorkerType' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$WorkerType' => 'The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.
', 'CreateJobRequest$WorkerType' => 'The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
MaxCapacity
and NumberOfWorkers
must both be at least 1.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
MaxCapacity
and NumberOfWorkers
must both be at least 1.
The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X
, G.2X
, G.4X
, or G.8X
for Spark sessions. Accepts the value Z.2X
for Ray sessions.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
A workflow is a collection of multiple dependent Glue jobs and crawlers that are run to complete a complex ETL task. A workflow manages the execution and monitoring of all its jobs and crawlers.
', 'refs' => [ 'GetWorkflowResponse$Workflow' => 'The resource metadata for the workflow.
', 'Workflows$member' => NULL, ], ], 'WorkflowGraph' => [ 'base' => 'A workflow graph represents the complete workflow containing all the Glue components present in the workflow and all the directed connections between them.
', 'refs' => [ 'Workflow$Graph' => 'The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
', 'WorkflowRun$Graph' => 'The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
', ], ], 'WorkflowNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetWorkflowsRequest$Names' => 'A list of workflow names, which may be the names returned from the ListWorkflows
operation.
A list of names of workflows not found.
', 'ListWorkflowsResponse$Workflows' => 'List of names of workflows in the account.
', ], ], 'WorkflowRun' => [ 'base' => 'A workflow run is an execution of a workflow providing all the runtime information.
', 'refs' => [ 'GetWorkflowRunResponse$Run' => 'The requested workflow run metadata.
', 'Workflow$LastRun' => 'The information about the last execution of the workflow.
', 'WorkflowRuns$member' => NULL, ], ], 'WorkflowRunProperties' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow.
', 'GetWorkflowRunPropertiesResponse$RunProperties' => 'The workflow run properties which were set during the specified run.
', 'PutWorkflowRunPropertiesRequest$RunProperties' => 'The properties to put for the specified run.
', 'StartWorkflowRunRequest$RunProperties' => 'The workflow run properties for the new workflow run.
', 'UpdateWorkflowRequest$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow.
', 'Workflow$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
', 'WorkflowRun$WorkflowRunProperties' => 'The workflow run properties which were set during the run.
', ], ], 'WorkflowRunStatistics' => [ 'base' => 'Workflow run statistics provides statistics about the workflow run.
', 'refs' => [ 'WorkflowRun$Statistics' => 'The statistics of the run.
', ], ], 'WorkflowRunStatus' => [ 'base' => NULL, 'refs' => [ 'WorkflowRun$Status' => 'The status of the workflow run.
', ], ], 'WorkflowRuns' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowRunsResponse$Runs' => 'A list of workflow run metadata objects.
', ], ], 'Workflows' => [ 'base' => NULL, 'refs' => [ 'BatchGetWorkflowsResponse$Workflows' => 'A list of workflow resource metadata.
', ], ], 'XMLClassifier' => [ 'base' => 'A classifier for XML
content.
A classifier for XML content.
', ], ], 'databaseNameString' => [ 'base' => NULL, 'refs' => [ 'BatchGetTableOptimizerEntry$databaseName' => 'The name of the database in the catalog in which the table resides.
', 'BatchGetTableOptimizerError$databaseName' => 'The name of the database in the catalog in which the table resides.
', 'BatchTableOptimizer$databaseName' => 'The name of the database in the catalog in which the table resides.
', ], ], 'tableNameString' => [ 'base' => NULL, 'refs' => [ 'BatchGetTableOptimizerEntry$tableName' => 'The name of the table.
', 'BatchGetTableOptimizerError$tableName' => 'The name of the table.
', 'BatchTableOptimizer$tableName' => 'The name of the table.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Defines the public endpoint for the Glue service.
', 'operations' => [ 'BatchCreatePartition' => 'Creates one or more partitions in a batch operation.
', 'BatchDeleteConnection' => 'Deletes a list of connection definitions from the Data Catalog.
', 'BatchDeletePartition' => 'Deletes one or more partitions in a batch operation.
', 'BatchDeleteTable' => 'Deletes multiple tables at once.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling BatchDeleteTable
, use DeleteTableVersion
or BatchDeleteTableVersion
, and DeletePartition
or BatchDeletePartition
, to delete any resources that belong to the table.
Deletes a specified batch of versions of a table.
', 'BatchGetBlueprints' => 'Retrieves information about a list of blueprints.
', 'BatchGetCrawlers' => 'Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves the details for the custom patterns specified by a list of names.
', 'BatchGetDataQualityResult' => 'Retrieves a list of data quality results for the specified result IDs.
', 'BatchGetDevEndpoints' => 'Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of job names. After calling the ListJobs
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves partitions in a batch request.
', 'BatchGetTableOptimizer' => 'Returns the configuration for the specified table optimizers.
', 'BatchGetTriggers' => 'Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows
operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Stops one or more job runs for a specified job definition.
', 'BatchUpdatePartition' => 'Updates one or more partitions in a batch operation.
', 'CancelDataQualityRuleRecommendationRun' => 'Cancels the specified recommendation run that was being used to generate rules.
', 'CancelDataQualityRulesetEvaluationRun' => 'Cancels a run where a ruleset is being evaluated against a data source.
', 'CancelMLTaskRun' => 'Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun
with a task run\'s parent transform\'s TransformID
and the task run\'s TaskRunId
.
Cancels the statement.
', 'CheckSchemaVersionValidity' => 'Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat
as the format. Since it does not take a schema set name, no compatibility checks are performed.
Registers a blueprint with Glue.
', 'CreateClassifier' => 'Creates a classifier in the user\'s account. This can be a GrokClassifier
, an XMLClassifier
, a JsonClassifier
, or a CsvClassifier
, depending on which field of the request is present.
Creates a connection definition in the Data Catalog.
Connections used for creating federated resources require the IAM glue:PassConnection
permission.
Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets
field, the jdbcTargets
field, or the DynamoDBTargets
field.
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.
', 'CreateDataQualityRuleset' => 'Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.
', 'CreateDatabase' => 'Creates a new database in a Data Catalog.
', 'CreateDevEndpoint' => 'Creates a new development endpoint.
', 'CreateJob' => 'Creates a new job definition.
', 'CreateMLTransform' => 'Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.
Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches
transform) for deduplicating data. You can provide an optional Description
, in addition to the parameters that you want to use for your algorithm.
You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include Role
, and optionally, AllocatedCapacity
, Timeout
, and MaxRetries
. For more information, see Jobs.
Creates a new partition.
', 'CreatePartitionIndex' => 'Creates a specified partition index in an existing table.
', 'CreateRegistry' => 'Creates a new registry which may be used to hold a collection of schemas.
', 'CreateSchema' => 'Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.
When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion
API is used.
When this API is called without a RegistryId
, this will create an entry for a "default-registry" in the registry database tables, if it is not already present.
Transforms a directed acyclic graph (DAG) into code.
', 'CreateSecurityConfiguration' => 'Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.
', 'CreateSession' => 'Creates a new session.
', 'CreateTable' => 'Creates a new table definition in the Data Catalog.
', 'CreateTableOptimizer' => 'Creates a new table optimizer for a specific function. compaction
is the only currently supported optimizer type.
Creates a new trigger.
', 'CreateUsageProfile' => 'Creates an Glue usage profile.
', 'CreateUserDefinedFunction' => 'Creates a new function definition in the Data Catalog.
', 'CreateWorkflow' => 'Creates a new workflow.
', 'DeleteBlueprint' => 'Deletes an existing blueprint.
', 'DeleteClassifier' => 'Removes a classifier from the Data Catalog.
', 'DeleteColumnStatisticsForPartition' => 'Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is DeletePartition
.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is DeleteTable
.
Deletes a connection from the Data Catalog.
', 'DeleteCrawler' => 'Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING
.
Deletes a custom pattern by specifying its name.
', 'DeleteDataQualityRuleset' => 'Deletes a data quality ruleset.
', 'DeleteDatabase' => 'Removes a specified database from a Data Catalog.
After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteDatabase
, use DeleteTableVersion
or BatchDeleteTableVersion
, DeletePartition
or BatchDeletePartition
, DeleteUserDefinedFunction
, and DeleteTable
or BatchDeleteTable
, to delete any resources that belong to the database.
Deletes a specified development endpoint.
', 'DeleteJob' => 'Deletes a specified job definition. If the job definition is not found, no exception is thrown.
', 'DeleteMLTransform' => 'Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms
. However, any Glue jobs that still reference the deleted transform will no longer succeed.
Deletes a specified partition.
', 'DeletePartitionIndex' => 'Deletes a specified partition index from an existing table.
', 'DeleteRegistry' => 'Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry
API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry
, CreateSchema
, UpdateSchema
, and RegisterSchemaVersion
APIs.
Deletes a specified policy.
', 'DeleteSchema' => 'Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema
API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition
, and RegisterSchemaVersion
APIs.
Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions
API after this call will list the status of the deleted versions.
When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint
API before using this API.
You cannot use the DeleteSchemaVersions
API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema
API. This operation will also delete the attached SchemaVersionMetadata
under the schema versions. Hard deletes will be enforced on the database.
If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
', 'DeleteSecurityConfiguration' => 'Deletes a specified security configuration.
', 'DeleteSession' => 'Deletes the session.
', 'DeleteTable' => 'Removes a table definition from the Data Catalog.
After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteTable
, use DeleteTableVersion
or BatchDeleteTableVersion
, and DeletePartition
or BatchDeletePartition
, to delete any resources that belong to the table.
Deletes an optimizer and all associated metadata for a table. The optimization will no longer be performed on the table.
', 'DeleteTableVersion' => 'Deletes a specified version of a table.
', 'DeleteTrigger' => 'Deletes a specified trigger. If the trigger is not found, no exception is thrown.
', 'DeleteUsageProfile' => 'Deletes the Glue specified usage profile.
', 'DeleteUserDefinedFunction' => 'Deletes an existing function definition from the Data Catalog.
', 'DeleteWorkflow' => 'Deletes a workflow.
', 'GetBlueprint' => 'Retrieves the details of a blueprint.
', 'GetBlueprintRun' => 'Retrieves the details of a blueprint run.
', 'GetBlueprintRuns' => 'Retrieves the details of blueprint runs for a specified blueprint.
', 'GetCatalogImportStatus' => 'Retrieves the status of a migration operation.
', 'GetClassifier' => 'Retrieve a classifier by name.
', 'GetClassifiers' => 'Lists all classifier objects in the Data Catalog.
', 'GetColumnStatisticsForPartition' => 'Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetPartition
.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetTable
.
Get the associated metadata/information for a task run, given a task run ID.
', 'GetColumnStatisticsTaskRuns' => 'Retrieves information about all runs associated with the specified table.
', 'GetConnection' => 'Retrieves a connection definition from the Data Catalog.
', 'GetConnections' => 'Retrieves a list of connection definitions from the Data Catalog.
', 'GetCrawler' => 'Retrieves metadata for a specified crawler.
', 'GetCrawlerMetrics' => 'Retrieves metrics about specified crawlers.
', 'GetCrawlers' => 'Retrieves metadata for all crawlers defined in the customer account.
', 'GetCustomEntityType' => 'Retrieves the details of a custom pattern by specifying its name.
', 'GetDataCatalogEncryptionSettings' => 'Retrieves the security configuration for a specified catalog.
', 'GetDataQualityResult' => 'Retrieves the result of a data quality rule evaluation.
', 'GetDataQualityRuleRecommendationRun' => 'Gets the specified recommendation run that was used to generate rules.
', 'GetDataQualityRuleset' => 'Returns an existing ruleset by identifier or name.
', 'GetDataQualityRulesetEvaluationRun' => 'Retrieves a specific run where a ruleset is evaluated against a data source.
', 'GetDatabase' => 'Retrieves the definition of a specified database.
', 'GetDatabases' => 'Retrieves all databases defined in a given Data Catalog.
', 'GetDataflowGraph' => 'Transforms a Python script into a directed acyclic graph (DAG).
', 'GetDevEndpoint' => 'Retrieves information about a specified development endpoint.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves all the development endpoints in this Amazon Web Services account.
When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
Retrieves an existing job definition.
', 'GetJobBookmark' => 'Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
', 'GetJobRun' => 'Retrieves the metadata for a given job run. Job run history is accessible for 90 days for your workflow and job run.
', 'GetJobRuns' => 'Retrieves metadata for all runs of a given job definition.
', 'GetJobs' => 'Retrieves all current job definitions.
', 'GetMLTaskRun' => 'Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun
with the TaskRunID
and its parent transform\'s TransformID
.
Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns
with their parent transform\'s TransformID
and other optional parameters as documented in this section.
This operation returns a list of historic runs and must be paginated.
', 'GetMLTransform' => 'Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform
.
Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling GetMLTransforms
.
Creates mappings.
', 'GetPartition' => 'Retrieves information about a specified partition.
', 'GetPartitionIndexes' => 'Retrieves the partition indexes associated with a table.
', 'GetPartitions' => 'Retrieves information about the partitions in a table.
', 'GetPlan' => 'Gets code to perform a specified mapping.
', 'GetRegistry' => 'Describes the specified registry in detail.
', 'GetResourcePolicies' => 'Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.
If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can\'t return the Data Catalog resource policy.
', 'GetResourcePolicy' => 'Retrieves a specified resource policy.
', 'GetSchema' => 'Describes the specified schema in detail.
', 'GetSchemaByDefinition' => 'Retrieves a schema by the SchemaDefinition
. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName
or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted
statuses will not be included in the results.
Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.
', 'GetSchemaVersionsDiff' => 'Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
', 'GetSecurityConfiguration' => 'Retrieves a specified security configuration.
', 'GetSecurityConfigurations' => 'Retrieves a list of all security configurations.
', 'GetSession' => 'Retrieves the session.
', 'GetStatement' => 'Retrieves the statement.
', 'GetTable' => 'Retrieves the Table
definition in a Data Catalog for a specified table.
Returns the configuration of all optimizers associated with a specified table.
', 'GetTableVersion' => 'Retrieves a specified version of a table.
', 'GetTableVersions' => 'Retrieves a list of strings that identify available versions of a specified table.
', 'GetTables' => 'Retrieves the definitions of some or all of the tables in a given Database
.
Retrieves a list of tags associated with a resource.
', 'GetTrigger' => 'Retrieves the definition of a trigger.
', 'GetTriggers' => 'Gets all the triggers associated with a job.
', 'GetUnfilteredPartitionMetadata' => 'Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetPartition
.
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is glue:GetPartitions
.
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
For IAM authorization, the public IAM action associated with this API is glue:GetTable
.
Retrieves information about the specified Glue usage profile.
', 'GetUserDefinedFunction' => 'Retrieves a specified function definition from the Data Catalog.
', 'GetUserDefinedFunctions' => 'Retrieves multiple function definitions from the Data Catalog.
', 'GetWorkflow' => 'Retrieves resource metadata for a workflow.
', 'GetWorkflowRun' => 'Retrieves the metadata for a given workflow run. Job run history is accessible for 90 days for your workflow and job run.
', 'GetWorkflowRunProperties' => 'Retrieves the workflow run properties which were set during the run.
', 'GetWorkflowRuns' => 'Retrieves metadata for all runs of a given workflow.
', 'ImportCatalogToGlue' => 'Imports an existing Amazon Athena Data Catalog to Glue.
', 'ListBlueprints' => 'Lists all the blueprint names in an account.
', 'ListColumnStatisticsTaskRuns' => 'List all task runs for a particular account.
', 'ListCrawlers' => 'Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags
field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.
You may use this API to:
Retrive all the crawls of a specified crawler.
Retrieve all the crawls of a specified crawler within a limited count.
Retrieve all the crawls of a specified crawler in a specific time range.
Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.
Lists all the custom patterns that have been created.
', 'ListDataQualityResults' => 'Returns all data quality execution results for your account.
', 'ListDataQualityRuleRecommendationRuns' => 'Lists the recommendation runs meeting the filter criteria.
', 'ListDataQualityRulesetEvaluationRuns' => 'Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
', 'ListDataQualityRulesets' => 'Returns a paginated list of rulesets for the specified list of Glue tables.
', 'ListDevEndpoints' => 'Retrieves the names of all DevEndpoint
resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags
field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags
field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags
field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.
Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting
status will not be included in the results. Empty results will be returned if there are no registries available.
Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.
', 'ListSchemas' => 'Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.
When the RegistryId
is not provided, all the schemas across registries will be part of the API response.
Retrieve a list of sessions.
', 'ListStatements' => 'Lists statements for the session.
', 'ListTableOptimizerRuns' => 'Lists the history of previous optimizer runs for a specific table.
', 'ListTriggers' => 'Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags
field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
List all the Glue usage profiles.
', 'ListWorkflows' => 'Lists names of workflows created in the account.
', 'PutDataCatalogEncryptionSettings' => 'Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.
', 'PutResourcePolicy' => 'Sets the Data Catalog resource policy for access control.
', 'PutSchemaVersionMetadata' => 'Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls.
', 'PutWorkflowRunProperties' => 'Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.
', 'QuerySchemaVersionMetadata' => 'Queries for the schema version metadata information.
', 'RegisterSchemaVersion' => 'Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion
API with the SchemaVersionId
to check compatibility modes.
If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.
', 'RemoveSchemaVersionMetadata' => 'Removes a key value pair from the schema version metadata for the specified schema version ID.
', 'ResetJobBookmark' => 'Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
', 'ResumeWorkflowRun' => 'Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.
', 'RunStatement' => 'Executes the statement.
', 'SearchTables' => 'Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
', 'StartBlueprintRun' => 'Starts a new run of the specified blueprint.
', 'StartColumnStatisticsTaskRun' => 'Starts a column statistics task run, for a specified table and columns.
', 'StartCrawler' => 'Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.
', 'StartCrawlerSchedule' => 'Changes the schedule state of the specified crawler to SCHEDULED
, unless the crawler is already running or the schedule state is already SCHEDULED
.
Starts a recommendation run that is used to generate rules when you don\'t know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
Recommendation runs are automatically deleted after 90 days.
', 'StartDataQualityRulesetEvaluationRun' => 'Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes results which you can retrieve with the GetDataQualityResult
API.
Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use StartExportLabelsTaskRun
when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the TransformId
whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId
. You can check on the status of your task run by calling the GetMLTaskRun
API.
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun
call and that ultimately results in improving the quality of your machine learning transform.
After the StartMLLabelingSetGenerationTaskRun
finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called \'labeling\' in the machine learning workflows). In the case of the FindMatches
transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to StartImportLabelsTaskRun
. After StartImportLabelsTaskRun
finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.
By default, StartMLLabelingSetGenerationTaskRun
continually learns from and combines all labels that you upload unless you set Replace
to true. If you set Replace
to true, StartImportLabelsTaskRun
deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.
You can check on the status of your task run by calling the GetMLTaskRun
operation.
Starts a job run using a job definition.
', 'StartMLEvaluationTaskRun' => 'Starts a task to estimate the quality of the transform.
When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.
Returns a unique identifier for the run. You can call GetMLTaskRun
to get more information about the stats of the EvaluationTaskRun
.
Starts the active learning workflow for your machine learning transform to improve the transform\'s quality by generating label sets and adding labels.
When the StartMLLabelingSetGenerationTaskRun
finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.
In the case of the FindMatches
transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”
After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun
. After StartImportLabelsTaskRun
finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.
Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.
', 'StartWorkflowRun' => 'Starts a new run of the specified workflow.
', 'StopColumnStatisticsTaskRun' => 'Stops a task run for the specified table.
', 'StopCrawler' => 'If the specified crawler is running, stops the crawl.
', 'StopCrawlerSchedule' => 'Sets the schedule state of the specified crawler to NOT_SCHEDULED
, but does not stop the crawler if it is already running.
Stops the session.
', 'StopTrigger' => 'Stops a specified trigger.
', 'StopWorkflowRun' => 'Stops the execution of the specified workflow run.
', 'TagResource' => 'Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you can tag, see Amazon Web Services Tags in Glue.
', 'UntagResource' => 'Removes tags from a resource.
', 'UpdateBlueprint' => 'Updates a registered blueprint.
', 'UpdateClassifier' => 'Modifies an existing classifier (a GrokClassifier
, an XMLClassifier
, a JsonClassifier
, or a CsvClassifier
, depending on which field is present).
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdatePartition
.
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is UpdateTable
.
Updates a connection definition in the Data Catalog.
', 'UpdateCrawler' => 'Updates a crawler. If a crawler is running, you must stop it using StopCrawler
before updating it.
Updates the schedule of a crawler using a cron
expression.
Updates the specified data quality ruleset.
', 'UpdateDatabase' => 'Updates an existing database definition in a Data Catalog.
', 'UpdateDevEndpoint' => 'Updates a specified development endpoint.
', 'UpdateJob' => 'Updates an existing job definition. The previous job definition is completely overwritten by this information.
', 'UpdateJobFromSourceControl' => 'Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.
This API supports optional parameters which take in the repository information.
', 'UpdateMLTransform' => 'Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.
After calling this operation, you can call the StartMLEvaluationTaskRun
operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).
Updates a partition.
', 'UpdateRegistry' => 'Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.
', 'UpdateSchema' => 'Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility
is provided, the VersionNumber
(a checkpoint) is also required. The API will validate the checkpoint version number for consistency.
If the value for the VersionNumber
(checkpoint) is provided, Compatibility
is optional and this can be used to set/reset a checkpoint for the schema.
This update will happen only if the schema is in the AVAILABLE state.
', 'UpdateSourceControlFromJob' => 'Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.
This API supports optional parameters which take in the repository information.
', 'UpdateTable' => 'Updates a metadata table in the Data Catalog.
', 'UpdateTableOptimizer' => 'Updates the configuration for an existing table optimizer.
', 'UpdateTrigger' => 'Updates a trigger definition.
', 'UpdateUsageProfile' => 'Update an Glue usage profile.
', 'UpdateUserDefinedFunction' => 'Updates an existing function definition in the Data Catalog.
', 'UpdateWorkflow' => 'Updates an existing workflow.
', ], 'shapes' => [ 'AWSManagedClientApplicationReference' => [ 'base' => NULL, 'refs' => [ 'OAuth2ClientApplication$AWSManagedClientApplicationReference' => 'The reference to the SaaS-side client app that is Amazon Web Services managed.
', ], ], 'AccessDeniedException' => [ 'base' => 'Access to a resource was denied.
', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$CustomerId' => 'The Amazon Web Services account ID.
', 'LakeFormationConfiguration$AccountId' => 'Required for cross account crawls. For same account crawls as the target data, this can be left as null.
', ], ], 'Action' => [ 'base' => 'Defines an action to be initiated by a trigger.
', 'refs' => [ 'ActionList$member' => NULL, ], ], 'ActionList' => [ 'base' => NULL, 'refs' => [ 'CreateTriggerRequest$Actions' => 'The actions initiated by this trigger when it fires.
', 'Trigger$Actions' => 'The actions initiated by this trigger.
', 'TriggerUpdate$Actions' => 'The actions initiated by this trigger.
', ], ], 'AdditionalContextMap' => [ 'base' => NULL, 'refs' => [ 'QuerySessionContext$AdditionalContext' => 'An opaque string-string map passed by the query engine.
', ], ], 'AdditionalOptionKeys' => [ 'base' => NULL, 'refs' => [ 'DQAdditionalOptions$key' => NULL, ], ], 'AdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'CatalogDeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'CatalogHudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'JDBCConnectorTarget$AdditionalOptions' => 'Additional connection options for the connector.
', 'S3CatalogDeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'S3CatalogHudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'S3DeltaCatalogTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3DeltaDirectTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3DeltaSource$AdditionalDeltaOptions' => 'Specifies additional connection options.
', 'S3HudiCatalogTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3HudiDirectTarget$AdditionalOptions' => 'Specifies additional connection options for the connector.
', 'S3HudiSource$AdditionalHudiOptions' => 'Specifies additional connection options.
', 'SnowflakeNodeData$AdditionalOptions' => 'Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
', 'SparkConnectorSource$AdditionalOptions' => 'Additional connection options for the connector.
', 'SparkConnectorTarget$AdditionalOptions' => 'Additional connection options for the connector.
', ], ], 'AdditionalPlanOptionsMap' => [ 'base' => NULL, 'refs' => [ 'GetPlanRequest$AdditionalPlanOptionsMap' => 'A map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported:
inferSchema
— Specifies whether to set inferSchema
to true or false for the default script generated by an Glue job. For example, to set inferSchema
to true, pass the following key value pair:
--additional-plan-options-map \'{"inferSchema":"true"}\'
Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
', ], ], 'Aggregate' => [ 'base' => 'Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
', 'refs' => [ 'CodeGenConfigurationNode$Aggregate' => 'Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
', ], ], 'AggregateOperation' => [ 'base' => 'Specifies the set of parameters needed to perform aggregation in the aggregate transform.
', 'refs' => [ 'AggregateOperations$member' => NULL, ], ], 'AggregateOperations' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Aggs' => 'Specifies the aggregate functions to be performed on specified fields.
', ], ], 'AllowedValuesStringList' => [ 'base' => NULL, 'refs' => [ 'ConfigurationObject$AllowedValues' => 'A list of allowed values for the parameter.
', ], ], 'AlreadyExistsException' => [ 'base' => 'A resource to be created or added already exists.
', 'refs' => [], ], 'AmazonRedshiftAdvancedOption' => [ 'base' => 'Specifies an optional value when connecting to the Redshift cluster.
', 'refs' => [ 'AmazonRedshiftAdvancedOptions$member' => NULL, ], ], 'AmazonRedshiftAdvancedOptions' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$AdvancedOptions' => 'Optional values when connecting to the Redshift cluster.
', ], ], 'AmazonRedshiftNodeData' => [ 'base' => 'Specifies an Amazon Redshift node.
', 'refs' => [ 'AmazonRedshiftSource$Data' => 'Specifies the data of the Amazon Reshift source node.
', 'AmazonRedshiftTarget$Data' => 'Specifies the data of the Amazon Redshift target node.
', ], ], 'AmazonRedshiftSource' => [ 'base' => 'Specifies an Amazon Redshift source.
', 'refs' => [ 'CodeGenConfigurationNode$AmazonRedshiftSource' => 'Specifies a target that writes to a data source in Amazon Redshift.
', ], ], 'AmazonRedshiftTarget' => [ 'base' => 'Specifies an Amazon Redshift target.
', 'refs' => [ 'CodeGenConfigurationNode$AmazonRedshiftTarget' => 'Specifies a target that writes to a data target in Amazon Redshift.
', ], ], 'ApplyMapping' => [ 'base' => 'Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
', 'refs' => [ 'CodeGenConfigurationNode$ApplyMapping' => 'Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
', ], ], 'ArnString' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredTableMetadataRequest$ParentResourceArn' => 'The resource ARN of the view.
', 'GetUnfilteredTableMetadataRequest$RootResourceArn' => 'The resource ARN of the root view in a chain of nested views.
', 'GetUnfilteredTableMetadataResponse$ResourceArn' => 'The resource ARN of the parent resource extracted from the request.
', 'TableOptimizerConfiguration$roleArn' => 'A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller\'s behalf.
', 'ViewDefinition$Definer' => 'The definer of a view in SQL.
', 'ViewDefinitionInput$Definer' => 'The definer of a view in SQL.
', 'ViewSubObjectsList$member' => NULL, ], ], 'AthenaConnectorSource' => [ 'base' => 'Specifies a connector to an Amazon Athena data source.
', 'refs' => [ 'CodeGenConfigurationNode$AthenaConnectorSource' => 'Specifies a connector to an Amazon Athena data source.
', ], ], 'AttemptCount' => [ 'base' => NULL, 'refs' => [ 'JobRun$Attempt' => 'The number of the attempt to run this job.
', ], ], 'AuditColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'AuditContext$RequestedColumns' => 'The requested columns for audit.
', ], ], 'AuditContext' => [ 'base' => 'A structure containing the Lake Formation audit context.
', 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', 'GetUnfilteredPartitionsMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', 'GetUnfilteredTableMetadataRequest$AuditContext' => 'A structure containing Lake Formation audit context information.
', ], ], 'AuditContextString' => [ 'base' => NULL, 'refs' => [ 'AuditContext$AdditionalAuditContext' => 'A string containing the additional audit context information.
', ], ], 'AuthTokenString' => [ 'base' => NULL, 'refs' => [ 'UpdateJobFromSourceControlRequest$AuthToken' => 'The value of the authorization token.
', 'UpdateSourceControlFromJobRequest$AuthToken' => 'The value of the authorization token.
', ], ], 'AuthenticationConfiguration' => [ 'base' => 'A structure containing the authentication configuration.
', 'refs' => [ 'Connection$AuthenticationConfiguration' => 'The authentication properties of the connection.
', ], ], 'AuthenticationConfigurationInput' => [ 'base' => 'A structure containing the authentication configuration in the CreateConnection request.
', 'refs' => [ 'ConnectionInput$AuthenticationConfiguration' => 'The authentication properties of the connection. Used for a Salesforce connection.
', ], ], 'AuthenticationType' => [ 'base' => NULL, 'refs' => [ 'AuthenticationConfiguration$AuthenticationType' => 'A structure containing the authentication configuration.
', 'AuthenticationConfigurationInput$AuthenticationType' => 'A structure containing the authentication configuration in the CreateConnection request.
', ], ], 'AuthorizationCode' => [ 'base' => NULL, 'refs' => [ 'AuthorizationCodeProperties$AuthorizationCode' => 'An authorization code to be used in the third leg of the AUTHORIZATION_CODE
grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.
The set of properties required for the the OAuth2 AUTHORIZATION_CODE
grant type workflow.
The set of properties required for the the OAuth2 AUTHORIZATION_CODE
grant type.
A list of errors that can occur when registering partition indexes for an existing table.
These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:
EncryptedPartitionError: The partitions are encrypted.
InvalidPartitionTypeDataError: The partition value doesn\'t match the data type for that partition column.
MissingPartitionValueError: The partitions are encrypted.
UnsupportedPartitionCharacterError: Characters inside the partition value are not supported. For example: U+0000 , U+0001, U+0002.
InternalError: Any error which does not belong to other error codes.
The error code for an error that occurred when registering partition indexes for an existing table.
', ], ], 'BackfillErroredPartitionsList' => [ 'base' => NULL, 'refs' => [ 'BackfillError$Partitions' => 'A list of a limited number of partitions in the response.
', ], ], 'BackfillErrors' => [ 'base' => NULL, 'refs' => [ 'PartitionIndexDescriptor$BackfillErrors' => 'A list of errors that can occur when registering partition indexes for an existing table.
', ], ], 'BasicCatalogTarget' => [ 'base' => 'Specifies a target that uses a Glue Data Catalog table.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogTarget' => 'Specifies a target that uses a Glue Data Catalog table.
', ], ], 'BatchCreatePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchCreatePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeletePartitionValueList' => [ 'base' => NULL, 'refs' => [ 'BatchDeletePartitionRequest$PartitionsToDelete' => 'A list of PartitionInput
structures that define the partitions to be deleted.
A list of the table to delete.
', ], ], 'BatchDeleteTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteTableVersionList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionRequest$VersionIds' => 'A list of the IDs of versions to be deleted. A VersionId
is a string representation of an integer. Each version is incremented by 1.
A list of blueprint names.
', ], ], 'BatchGetBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCustomEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetCustomEntityTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDataQualityResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDataQualityResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetPartitionValueList' => [ 'base' => NULL, 'refs' => [ 'BatchGetPartitionRequest$PartitionsToGet' => 'A list of partition values identifying the partitions to retrieve.
', 'BatchGetPartitionResponse$UnprocessedKeys' => 'A list of the partition values in the request for which partitions were not returned.
', ], ], 'BatchGetTableOptimizerEntries' => [ 'base' => NULL, 'refs' => [ 'BatchGetTableOptimizerRequest$Entries' => 'A list of BatchGetTableOptimizerEntry
objects specifying the table optimizers to retrieve.
Represents a table optimizer to retrieve in the BatchGetTableOptimizer
operation.
Contains details on one of the errors in the error list returned by the BatchGetTableOptimizer
operation.
A list of errors from the operation.
', ], ], 'BatchGetTableOptimizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTableOptimizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchSize' => [ 'base' => NULL, 'refs' => [ 'EventBatchingCondition$BatchSize' => 'Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
', ], ], 'BatchStopJobRunError' => [ 'base' => 'Records an error that occurred when attempting to stop a specified job run.
', 'refs' => [ 'BatchStopJobRunErrorList$member' => NULL, ], ], 'BatchStopJobRunErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchStopJobRunResponse$Errors' => 'A list of the errors that were encountered in trying to stop JobRuns
, including the JobRunId
for which each error was encountered and details about the error.
A list of the JobRunIds
that should be stopped for that job definition.
Records a successful request to stop a specified JobRun
.
A list of the JobRuns that were successfully submitted for stopping.
', ], ], 'BatchTableOptimizer' => [ 'base' => 'Contains details for one of the table optimizers returned by the BatchGetTableOptimizer
operation.
A list of BatchTableOptimizer
objects.
Contains information about a batch update partition error.
', 'refs' => [ 'BatchUpdatePartitionFailureList$member' => NULL, ], ], 'BatchUpdatePartitionFailureList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePartitionResponse$Errors' => 'The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry
objects.
A structure that contains the values and structure used to update a partition.
', 'refs' => [ 'BatchUpdatePartitionRequestEntryList$member' => NULL, ], ], 'BatchUpdatePartitionRequestEntryList' => [ 'base' => NULL, 'refs' => [ 'BatchUpdatePartitionRequest$Entries' => 'A list of up to 100 BatchUpdatePartitionRequestEntry
objects to update.
Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
', ], ], 'BinaryColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for bit sequence data values.
', 'refs' => [ 'ColumnStatisticsData$BinaryColumnStatisticsData' => 'Binary column statistics data.
', ], ], 'Blob' => [ 'base' => NULL, 'refs' => [ 'DecimalNumber$UnscaledValue' => 'The unscaled numeric value.
', ], ], 'Blueprint' => [ 'base' => 'The details of a blueprint.
', 'refs' => [ 'Blueprints$member' => NULL, 'GetBlueprintResponse$Blueprint' => 'Returns a Blueprint
object.
The details of a blueprint.
', 'refs' => [ 'Workflow$BlueprintDetails' => 'This structure indicates the details of the blueprint that this particular workflow is created from.
', ], ], 'BlueprintNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetBlueprintsResponse$MissingBlueprints' => 'Returns a list of BlueprintNames
that were not found.
List of names of blueprints in the account.
', ], ], 'BlueprintParameterSpec' => [ 'base' => NULL, 'refs' => [ 'Blueprint$ParameterSpec' => 'A JSON string that indicates the list of parameter specifications for the blueprint.
', 'LastActiveDefinition$ParameterSpec' => 'A JSON string specifying the parameters for the blueprint.
', ], ], 'BlueprintParameters' => [ 'base' => NULL, 'refs' => [ 'BlueprintRun$Parameters' => 'The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec
.
Specifies the parameters as a BlueprintParameters
object.
The details of a blueprint run.
', 'refs' => [ 'BlueprintRuns$member' => NULL, 'GetBlueprintRunResponse$BlueprintRun' => 'Returns a BlueprintRun
object.
The state of the blueprint run. Possible values are:
Running — The blueprint run is in progress.
Succeeded — The blueprint run completed successfully.
Failed — The blueprint run failed and rollback is complete.
Rolling Back — The blueprint run failed and rollback is in progress.
Returns a list of BlueprintRun
objects.
The status of the blueprint registration.
Creating — The blueprint registration is in progress.
Active — The blueprint has been successfully registered.
Updating — An update to the blueprint registration is in progress.
Failed — The blueprint registration failed.
Returns a list of blueprint as a Blueprints
object.
True
if the migration has completed, or False
otherwise.
True if the value is used as a parameter.
', 'ConnectionInput$ValidateCredentials' => 'A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.
', 'ConnectionPasswordEncryption$ReturnConnectionPasswordEncrypted' => 'When the ReturnConnectionPasswordEncrypted
flag is set to "true", passwords remain encrypted in the responses of GetConnection
and GetConnections
. This encryption takes effect independently from catalog encryption.
True if the crawler is still estimating how long it will take to complete this run.
', 'GetConnectionRequest$HidePassword' => 'Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
', 'GetConnectionsRequest$HidePassword' => 'Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
', 'GetUnfilteredPartitionMetadataResponse$IsRegisteredWithLakeFormation' => 'A Boolean value that indicates whether the partition location is registered with Lake Formation.
', 'GetUnfilteredTableMetadataResponse$IsRegisteredWithLakeFormation' => 'A Boolean value that indicates whether the partition location is registered with Lake Formation.
', 'GetUnfilteredTableMetadataResponse$IsMultiDialectView' => 'Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
', 'GetUnfilteredTableMetadataResponse$IsProtected' => 'A flag that instructs the engine not to push user-provided operations into the logical plan of the view during query planning. However, if set this flag does not guarantee that the engine will comply. Refer to the engine\'s documentation to understand the guarantees provided, if any.
', 'StorageDescriptor$Compressed' => ' True
if the data in the table is compressed, or False
if not.
True
if the table data is stored in subdirectories, or False
if not.
Indicates whether the table has been registered with Lake Formation.
', 'UnfilteredPartition$IsRegisteredWithLakeFormation' => 'A Boolean value indicating that the partition location is registered with Lake Formation.
', 'UpdateTableRequest$Force' => 'A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.
', ], ], 'BooleanColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for Boolean data columns.
', 'refs' => [ 'ColumnStatisticsData$BooleanColumnStatisticsData' => 'Boolean column statistics data.
', ], ], 'BooleanNullable' => [ 'base' => NULL, 'refs' => [ 'GetPartitionsRequest$ExcludeColumnSchema' => 'When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
', 'UpdateTableRequest$SkipArchive' => 'By default, UpdateTable
always creates an archived version of the table before updating it. However, if skipArchive
is set to true, UpdateTable
does not create the archived version.
The action used on Redshift sinks when doing an APPEND.
', 'CreateTriggerRequest$StartOnCreation' => 'Set to true
to start SCHEDULED
and CONDITIONAL
triggers when created. True is not supported for ON_DEMAND
triggers.
True if a list of predecessor runs should be returned.
', 'S3CsvSource$OptimizePerformance' => 'A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
', 'SnowflakeNodeData$Upsert' => 'Used when Action is append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.
Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
', 'UpdateDevEndpointRequest$UpdateEtlLibraries' => ' True
if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False
if otherwise.
A list of values defining the partitions.
', 'BatchUpdatePartitionRequestEntry$PartitionValueList' => 'A list of values defining the partitions.
', 'UpdatePartitionRequest$PartitionValueList' => 'List of partition key values that define the partition to update.
', ], ], 'BoxedBoolean' => [ 'base' => NULL, 'refs' => [ 'CatalogKafkaSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'CatalogKinesisSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'CatalogSchemaChangePolicy$EnableUpdateCatalog' => 'Whether to use the specified update behavior when the crawler finds a changed schema.
', 'DQResultsPublishingOptions$CloudWatchMetricsEnabled' => 'Enable metrics for your data quality results.
', 'DQResultsPublishingOptions$ResultsPublishingEnabled' => 'Enable publishing for your data quality results.
', 'DirectKafkaSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'DirectKinesisSource$DetectSchema' => 'Whether to automatically determine the schema from the incoming data.
', 'DirectSchemaChangePolicy$EnableUpdateCatalog' => 'Whether to use the specified update behavior when the crawler finds a changed schema.
', 'FilterExpression$Negated' => 'Whether the expression is to be negated.
', 'KafkaStreamingSourceOptions$IncludeHeaders' => 'Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.
Adds a time delay between two consecutive getRecords operations. The default value is "False"
. This option is only configurable for Glue version 2.0 and above.
Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False"
.
If true, then the column is removed.
', 'NullCheckBoxList$IsEmpty' => 'Specifies that an empty string is considered as a null value.
', 'NullCheckBoxList$IsNullString' => 'Specifies that a value spelling out the word \'null\' is considered as a null value.
', 'NullCheckBoxList$IsNegOne' => 'Specifies that an integer value of -1 is considered as a null value.
', 'S3CsvSource$Recurse' => 'If set to true, recursively reads files in all subdirectories under the specified paths.
', 'S3CsvSource$Multiline' => 'A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False
, which allows for more aggressive file-splitting during parsing.
A Boolean value that specifies whether to treat the first line as a header. The default value is False
.
A Boolean value that specifies whether to write the header to output. The default value is True
.
A Boolean value that specifies whether to skip the first data line. The default value is False
.
Sets option to enable a sample path.
', 'S3JsonSource$Recurse' => 'If set to true, recursively reads files in all subdirectories under the specified paths.
', 'S3JsonSource$Multiline' => 'A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False
, which allows for more aggressive file-splitting during parsing.
If set to true, recursively reads files in all subdirectories under the specified paths.
', 'TransformConfigParameter$IsOptional' => 'Specifies whether the parameter is optional or not in the config file of the dynamic transform.
', ], ], 'BoxedDoubleFraction' => [ 'base' => NULL, 'refs' => [ 'PIIDetection$SampleFraction' => 'Indicates the fraction of the data to sample when scanning for PII entities.
', 'PIIDetection$ThresholdFraction' => 'Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
', ], ], 'BoxedLong' => [ 'base' => NULL, 'refs' => [ 'S3DirectSourceAdditionalOptions$BoundedSize' => 'Sets the upper limit for the target size of the dataset in bytes that will be processed.
', 'S3DirectSourceAdditionalOptions$BoundedFiles' => 'Sets the upper limit for the target number of files that will be processed.
', 'S3SourceAdditionalOptions$BoundedSize' => 'Sets the upper limit for the target size of the dataset in bytes that will be processed.
', 'S3SourceAdditionalOptions$BoundedFiles' => 'Sets the upper limit for the target number of files that will be processed.
', ], ], 'BoxedNonNegativeInt' => [ 'base' => NULL, 'refs' => [ 'KafkaStreamingSourceOptions$NumRetries' => 'The number of times to retry before failing to fetch Kafka offsets. The default value is 3
.
The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
', 'KinesisStreamingSourceOptions$NumRetries' => 'The maximum number of retries for Kinesis Data Streams API requests. The default value is 3
.
This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3CsvSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', 'S3JsonSource$MaxBand' => 'This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3JsonSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', 'S3ParquetSource$MaxBand' => 'This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don\'t need to set this option. The default is 900000 milliseconds, or 15 minutes.
', 'S3ParquetSource$MaxFilesInBand' => 'This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
', ], ], 'BoxedNonNegativeLong' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorOptions$LowerBound' => 'The minimum value of partitionColumn
that is used to decide partition stride.
The maximum value of partitionColumn
that is used to decide partition stride.
The number of partitions. This value, along with lowerBound
(inclusive) and upperBound
(exclusive), form partition strides for generated WHERE
clause expressions that are used to split the partitionColumn
.
The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512
.
The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10
.
The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple GetRecords
API calls may be made within this time. The default value is 1000
.
The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple of MaxRecordPerRead
. The default value is 100000
.
The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000
.
The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000
. This option is only configurable for Glue version 2.0 and above.
The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s
.
The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000
.
The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000
.
The amount of time to spend processing each micro batch.
', 'CatalogKinesisSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', 'DirectKafkaSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', 'DirectKinesisSource$WindowSize' => 'The amount of time to spend processing each micro batch.
', ], ], 'CancelDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelMLTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelMLTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'CancelStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'CatalogDeltaSource' => [ 'base' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogDeltaSource' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
', ], ], 'CatalogEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRest$CatalogEncryptionMode' => 'The encryption-at-rest mode for encrypting Data Catalog data.
', ], ], 'CatalogEntries' => [ 'base' => NULL, 'refs' => [ 'GetMappingRequest$Sinks' => 'A list of target tables.
', 'GetPlanRequest$Sinks' => 'The target tables.
', ], ], 'CatalogEntry' => [ 'base' => 'Specifies a table definition in the Glue Data Catalog.
', 'refs' => [ 'CatalogEntries$member' => NULL, 'GetMappingRequest$Source' => 'Specifies the source table.
', 'GetPlanRequest$Source' => 'The source table.
', ], ], 'CatalogGetterPageSize' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$MaxResults' => 'The maximum number of databases to return in one response.
', 'GetTableVersionsRequest$MaxResults' => 'The maximum number of table versions to return in one response.
', 'GetTablesRequest$MaxResults' => 'The maximum number of tables to return in a single response.
', 'GetUserDefinedFunctionsRequest$MaxResults' => 'The maximum number of functions to return in one response.
', ], ], 'CatalogHudiSource' => [ 'base' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogHudiSource' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog.
', ], ], 'CatalogIdString' => [ 'base' => NULL, 'refs' => [ 'BatchCreatePartitionRequest$CatalogId' => 'The ID of the catalog in which the partition is to be created. Currently, this should be the Amazon Web Services account ID.
', 'BatchDeleteConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeletePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeleteTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchDeleteTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'BatchGetPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'BatchGetTableOptimizerEntry$catalogId' => 'The Catalog ID of the table.
', 'BatchGetTableOptimizerError$catalogId' => 'The Catalog ID of the table.
', 'BatchTableOptimizer$catalogId' => 'The Catalog ID of the table.
', 'BatchUpdatePartitionRequest$CatalogId' => 'The ID of the catalog in which the partition is to be updated. Currently, this should be the Amazon Web Services account ID.
', 'ColumnStatisticsTaskRun$CatalogID' => 'The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
', 'CreateConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services account ID is used by default.
', 'CreateDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services account ID is used by default.
', 'CreatePartitionIndexRequest$CatalogId' => 'The catalog ID where the table resides.
', 'CreatePartitionRequest$CatalogId' => 'The Amazon Web Services account ID of the catalog in which the partition is to be created.
', 'CreateTableOptimizerRequest$CatalogId' => 'The Catalog ID of the table.
', 'CreateTableRequest$CatalogId' => 'The ID of the Data Catalog in which to create the Table
. If none is supplied, the Amazon Web Services account ID is used by default.
The ID of the Data Catalog in which to create the function. If none is provided, the Amazon Web Services account ID is used by default.
', 'Database$CatalogId' => 'The ID of the Data Catalog in which the database resides.
', 'DatabaseIdentifier$CatalogId' => 'The ID of the Data Catalog in which the database resides.
', 'DeleteColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'DeleteColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'DeleteConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeletePartitionIndexRequest$CatalogId' => 'The catalog ID where the table resides.
', 'DeletePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteTableOptimizerRequest$CatalogId' => 'The Catalog ID of the table.
', 'DeleteTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'DeleteUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetCatalogImportStatusRequest$CatalogId' => 'The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.
', 'GetColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'GetConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetConnectionsRequest$CatalogId' => 'The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDataCatalogEncryptionSettingsRequest$CatalogId' => 'The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetDatabasesRequest$CatalogId' => 'The ID of the Data Catalog from which to retrieve Databases
. If none is provided, the Amazon Web Services account ID is used by default.
The catalog ID where the table resides.
', 'GetPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetPartitionsRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableOptimizerRequest$CatalogId' => 'The Catalog ID of the table.
', 'GetTableOptimizerResponse$CatalogId' => 'The Catalog ID of the table.
', 'GetTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableVersionRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTableVersionsRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetTablesRequest$CatalogId' => 'The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetUnfilteredPartitionMetadataRequest$CatalogId' => 'The catalog ID where the partition resides.
', 'GetUnfilteredPartitionsMetadataRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default.
', 'GetUnfilteredTableMetadataRequest$CatalogId' => 'The catalog ID where the table resides.
', 'GetUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the Amazon Web Services account ID is used by default.
', 'GetUserDefinedFunctionsRequest$CatalogId' => 'The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the Amazon Web Services account ID is used by default.
', 'ImportCatalogToGlueRequest$CatalogId' => 'The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.
', 'ListTableOptimizerRunsRequest$CatalogId' => 'The Catalog ID of the table.
', 'ListTableOptimizerRunsResponse$CatalogId' => 'The Catalog ID of the table.
', 'Partition$CatalogId' => 'The ID of the Data Catalog in which the partition resides.
', 'PutDataCatalogEncryptionSettingsRequest$CatalogId' => 'The ID of the Data Catalog to set the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
', 'SearchTablesRequest$CatalogId' => 'A unique identifier, consisting of account_id
.
The ID of the Data Catalog in which the table resides.
', 'TableIdentifier$CatalogId' => 'The ID of the Data Catalog in which the table resides.
', 'UpdateColumnStatisticsForPartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'UpdateColumnStatisticsForTableRequest$CatalogId' => 'The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'UpdateConnectionRequest$CatalogId' => 'The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateDatabaseRequest$CatalogId' => 'The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdatePartitionRequest$CatalogId' => 'The ID of the Data Catalog where the partition to be updated resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateTableOptimizerRequest$CatalogId' => 'The Catalog ID of the table.
', 'UpdateTableRequest$CatalogId' => 'The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
', 'UpdateUserDefinedFunctionRequest$CatalogId' => 'The ID of the Data Catalog where the function to be updated is located. If none is provided, the Amazon Web Services account ID is used by default.
', 'UserDefinedFunction$CatalogId' => 'The ID of the Data Catalog in which the function resides.
', ], ], 'CatalogImportStatus' => [ 'base' => 'A structure containing migration status information.
', 'refs' => [ 'GetCatalogImportStatusResponse$ImportStatus' => 'The status of the specified catalog migration.
', ], ], 'CatalogKafkaSource' => [ 'base' => 'Specifies an Apache Kafka data store in the Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogKafkaSource' => 'Specifies an Apache Kafka data store in the Data Catalog.
', ], ], 'CatalogKinesisSource' => [ 'base' => 'Specifies a Kinesis data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogKinesisSource' => 'Specifies a Kinesis data source in the Glue Data Catalog.
', ], ], 'CatalogSchemaChangePolicy' => [ 'base' => 'A policy that specifies update behavior for the crawler.
', 'refs' => [ 'GovernedCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the governed catalog.
', 'S3CatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3DeltaCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3HudiCatalogTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', ], ], 'CatalogSource' => [ 'base' => 'Specifies a data store in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$CatalogSource' => 'Specifies a data store in the Glue Data Catalog.
', ], ], 'CatalogTablesList' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$Tables' => 'A list of the tables to be synchronized.
', ], ], 'CatalogTarget' => [ 'base' => 'Specifies an Glue Data Catalog target.
', 'refs' => [ 'CatalogTargetList$member' => NULL, ], ], 'CatalogTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$CatalogTargets' => 'Specifies Glue Data Catalog targets.
', ], ], 'CheckSchemaVersionValidityInput' => [ 'base' => NULL, 'refs' => [], ], 'CheckSchemaVersionValidityResponse' => [ 'base' => NULL, 'refs' => [], ], 'Classification' => [ 'base' => NULL, 'refs' => [ 'CreateGrokClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
', 'CreateXMLClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches.
', 'GrokClassifier$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
', 'UpdateGrokClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.
', 'UpdateXMLClassifierRequest$Classification' => 'An identifier of the data format that the classifier matches.
', 'XMLClassifier$Classification' => 'An identifier of the data format that the classifier matches.
', ], ], 'Classifier' => [ 'base' => 'Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType
object that matches that data format.
You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok
classifier, an XML
classifier, a JSON
classifier, or a custom CSV
classifier, as specified in one of the fields in the Classifier
object.
The requested classifier.
', ], ], 'ClassifierList' => [ 'base' => NULL, 'refs' => [ 'GetClassifiersResponse$Classifiers' => 'The requested list of classifier objects.
', ], ], 'ClassifierNameList' => [ 'base' => NULL, 'refs' => [ 'Crawler$Classifiers' => 'A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
', 'CreateCrawlerRequest$Classifiers' => 'A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
', 'UpdateCrawlerRequest$Classifiers' => 'A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
', ], ], 'CloudWatchEncryption' => [ 'base' => 'Specifies how Amazon CloudWatch data should be encrypted.
', 'refs' => [ 'EncryptionConfiguration$CloudWatchEncryption' => 'The encryption configuration for Amazon CloudWatch.
', ], ], 'CloudWatchEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEncryption$CloudWatchEncryptionMode' => 'The encryption mode to use for CloudWatch data.
', ], ], 'CodeGenArgName' => [ 'base' => NULL, 'refs' => [ 'CodeGenEdge$TargetParameter' => 'The target of the edge.
', 'CodeGenNodeArg$Name' => 'The name of the argument or property.
', ], ], 'CodeGenArgValue' => [ 'base' => NULL, 'refs' => [ 'CodeGenNodeArg$Value' => 'The value of the argument or property.
', ], ], 'CodeGenConfigurationNode' => [ 'base' => ' CodeGenConfigurationNode
enumerates all valid Node types. One and only one of its member variables can be populated.
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', 'Job$CodeGenConfigurationNodes' => 'The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', 'JobUpdate$CodeGenConfigurationNodes' => 'The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
', ], ], 'CodeGenEdge' => [ 'base' => 'Represents a directional edge in a directed acyclic graph (DAG).
', 'refs' => [ 'DagEdges$member' => NULL, ], ], 'CodeGenIdentifier' => [ 'base' => NULL, 'refs' => [ 'CodeGenEdge$Source' => 'The ID of the node at which the edge starts.
', 'CodeGenEdge$Target' => 'The ID of the node at which the edge ends.
', 'CodeGenNode$Id' => 'A node identifier that is unique within the node\'s graph.
', ], ], 'CodeGenNode' => [ 'base' => 'Represents a node in a directed acyclic graph (DAG)
', 'refs' => [ 'DagNodes$member' => NULL, ], ], 'CodeGenNodeArg' => [ 'base' => 'An argument or property of a node.
', 'refs' => [ 'CodeGenNodeArgs$member' => NULL, ], ], 'CodeGenNodeArgs' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$Args' => 'Properties of the node, in the form of name-value pairs.
', 'Location$Jdbc' => 'A JDBC location.
', 'Location$S3' => 'An Amazon Simple Storage Service (Amazon S3) location.
', 'Location$DynamoDB' => 'An Amazon DynamoDB table location.
', ], ], 'CodeGenNodeType' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$NodeType' => 'The type of node that this is.
', ], ], 'Column' => [ 'base' => 'A column in a Table
.
Encapsulates a column name that failed and the reason for failure.
', 'refs' => [ 'ColumnErrors$member' => NULL, ], ], 'ColumnErrors' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionResponse$Errors' => 'Error occurred during retrieving column statistics data.
', 'GetColumnStatisticsForTableResponse$Errors' => 'List of ColumnStatistics that failed to be retrieved.
', ], ], 'ColumnImportance' => [ 'base' => 'A structure containing the column name and column importance score for a column.
Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
', 'refs' => [ 'ColumnImportanceList$member' => NULL, ], ], 'ColumnImportanceList' => [ 'base' => NULL, 'refs' => [ 'FindMatchesMetrics$ColumnImportances' => 'A list of ColumnImportance
structures containing column importance metrics, sorted in order of descending importance.
A list of the Columns
in the table.
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys
, you must at least set the value of partitionKeys
to an empty list. For example:
"PartitionKeys": []
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys
, you must at least set the value of partitionKeys
to an empty list. For example:
"PartitionKeys": []
A list of the column names. If none is supplied, all column names for the table will be used by default.
', 'StartColumnStatisticsTaskRunRequest$ColumnNameList' => 'A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
', ], ], 'ColumnNameString' => [ 'base' => NULL, 'refs' => [ 'AuditColumnNamesList$member' => NULL, 'FindMatchesParameters$PrimaryKeyColumnName' => 'The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
', 'SchemaColumn$Name' => 'The name of the column.
', ], ], 'ColumnRowFilter' => [ 'base' => 'A filter that uses both column-level and row-level filtering.
', 'refs' => [ 'ColumnRowFilterList$member' => NULL, ], ], 'ColumnRowFilterList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredTableMetadataResponse$CellFilters' => 'A list of column row filters.
', ], ], 'ColumnStatistics' => [ 'base' => 'Represents the generated column-level statistics for a table or partition.
', 'refs' => [ 'ColumnStatisticsError$ColumnStatistics' => 'The ColumnStatistics
of the column.
Contains the individual types of column statistics data. Only one data object should be set and indicated by the Type
attribute.
A ColumnStatisticData
object that contains the statistics data values.
Encapsulates a ColumnStatistics
object that failed and the reason for failure.
Error occurred during updating column statistics data.
', 'UpdateColumnStatisticsForTableResponse$Errors' => 'List of ColumnStatisticsErrors.
', ], ], 'ColumnStatisticsList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionResponse$ColumnStatisticsList' => 'List of ColumnStatistics that failed to be retrieved.
', 'GetColumnStatisticsForTableResponse$ColumnStatisticsList' => 'List of ColumnStatistics.
', ], ], 'ColumnStatisticsState' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$Status' => 'The status of the task run.
', ], ], 'ColumnStatisticsTaskNotRunningException' => [ 'base' => 'An exception thrown when you try to stop a task run when there is no task running.
', 'refs' => [], ], 'ColumnStatisticsTaskRun' => [ 'base' => 'The object that shows the details of the column stats run.
', 'refs' => [ 'ColumnStatisticsTaskRunsList$member' => NULL, 'GetColumnStatisticsTaskRunResponse$ColumnStatisticsTaskRun' => 'A ColumnStatisticsTaskRun
object representing the details of the column stats run.
A list of column statistics task run IDs.
', ], ], 'ColumnStatisticsTaskRunningException' => [ 'base' => 'An exception thrown when you try to start another job while running a column stats generation job.
', 'refs' => [], ], 'ColumnStatisticsTaskRunsList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsTaskRunsResponse$ColumnStatisticsTaskRuns' => 'A list of column statistics task runs.
', ], ], 'ColumnStatisticsTaskStoppingException' => [ 'base' => 'An exception thrown when you try to stop a task run.
', 'refs' => [], ], 'ColumnStatisticsType' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsData$Type' => 'The type of column statistics data.
', ], ], 'ColumnTypeString' => [ 'base' => NULL, 'refs' => [ 'Column$Type' => 'The data type of the Column
.
The hive type for this column in the Glue Studio schema.
', 'KeySchemaElement$Type' => 'The type of a partition key.
', 'SchemaColumn$DataType' => 'The type of data in the column.
', ], ], 'ColumnValueStringList' => [ 'base' => NULL, 'refs' => [ 'SkewedInfo$SkewedColumnValues' => 'A list of values that appear so frequently as to be considered skewed.
', ], ], 'ColumnValuesString' => [ 'base' => NULL, 'refs' => [ 'ColumnValueStringList$member' => NULL, 'LocationMap$key' => NULL, 'LocationMap$value' => NULL, ], ], 'CommentString' => [ 'base' => NULL, 'refs' => [ 'Column$Comment' => 'A free-form text comment.
', ], ], 'CommitIdString' => [ 'base' => NULL, 'refs' => [ 'UpdateJobFromSourceControlRequest$CommitId' => 'A commit ID for a commit in the remote repository.
', 'UpdateSourceControlFromJobRequest$CommitId' => 'A commit ID for a commit in the remote repository.
', ], ], 'Comparator' => [ 'base' => NULL, 'refs' => [ 'PropertyPredicate$Comparator' => 'The comparator used to compare this property to others.
', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaInput$Compatibility' => 'The compatibility mode of the schema. The possible values are:
NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can\'t be read by readers using the previous version.
BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
The schema compatibility mode.
', 'GetSchemaResponse$Compatibility' => 'The compatibility mode of the schema.
', 'UpdateSchemaInput$Compatibility' => 'The new compatibility setting for the schema.
', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'S3CsvSource$CompressionType' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Two processes are trying to modify a resource simultaneously.
', 'refs' => [], ], 'ConcurrentRunsExceededException' => [ 'base' => 'Too many jobs are being run concurrently.
', 'refs' => [], ], 'Condition' => [ 'base' => 'Defines a condition under which a trigger fires.
', 'refs' => [ 'ConditionList$member' => NULL, ], ], 'ConditionCheckFailureException' => [ 'base' => 'A specified condition was not satisfied.
', 'refs' => [], ], 'ConditionList' => [ 'base' => NULL, 'refs' => [ 'Predicate$Conditions' => 'A list of the conditions that determine when the trigger will fire.
', ], ], 'ConfigValueString' => [ 'base' => NULL, 'refs' => [ 'AllowedValuesStringList$member' => NULL, 'ConfigurationObject$DefaultValue' => 'A default value for the parameter.
', 'ConfigurationObject$MinValue' => 'A minimum allowed value for the parameter.
', 'ConfigurationObject$MaxValue' => 'A maximum allowed value for the parameter.
', ], ], 'ConfigurationMap' => [ 'base' => NULL, 'refs' => [ 'ProfileConfiguration$SessionConfiguration' => 'A key-value map of configuration parameters for Glue sessions.
', 'ProfileConfiguration$JobConfiguration' => 'A key-value map of configuration parameters for Glue jobs.
', ], ], 'ConfigurationObject' => [ 'base' => 'Specifies the values that an admin sets for each job or session parameter configured in a Glue usage profile.
', 'refs' => [ 'ConfigurationMap$value' => NULL, ], ], 'ConflictException' => [ 'base' => 'The CreatePartitions
API was called on a table that has indexes enabled.
The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
', 'refs' => [ 'FindMatchesMetrics$ConfusionMatrix' => 'The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
', ], ], 'Connection' => [ 'base' => 'Defines a connection to a data source.
', 'refs' => [ 'ConnectionList$member' => NULL, 'GetConnectionResponse$Connection' => 'The requested connection definition.
', ], ], 'ConnectionInput' => [ 'base' => 'A structure that is used to specify a connection to create or update.
', 'refs' => [ 'CreateConnectionRequest$ConnectionInput' => 'A ConnectionInput
object defining the connection to create.
A ConnectionInput
object that redefines the connection in question.
A list of requested connection definitions.
', ], ], 'ConnectionName' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$ConnectionName' => 'The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog
connection type paired with a NETWORK
Connection type.
The name of the connection to use to connect to the Delta table target.
', 'HudiTarget$ConnectionName' => 'The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
', 'IcebergTarget$ConnectionName' => 'The name of the connection to use to connect to the Iceberg target.
', 'JdbcTarget$ConnectionName' => 'The name of the connection to use to connect to the JDBC target.
', 'MongoDBTarget$ConnectionName' => 'The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
', 'S3Target$ConnectionName' => 'The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
', ], ], 'ConnectionPasswordEncryption' => [ 'base' => 'The data structure used by the Data Catalog to encrypt the password as part of CreateConnection
or UpdateConnection
and store it in the ENCRYPTED_PASSWORD
field in the connection properties. You can enable catalog encryption or only password encryption.
When a CreationConnection
request arrives containing a password, the Data Catalog first encrypts the password using your KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.
This encryption requires that you set KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.
', 'refs' => [ 'DataCatalogEncryptionSettings$ConnectionPasswordEncryption' => 'When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection
or UpdateConnection
and store it in the ENCRYPTED_PASSWORD
field in the connection properties. You can enable catalog encryption or only password encryption.
These key-value pairs define parameters for the connection:
HOST
- The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT
- The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME
- The name under which to log in to the database. The value string for USER_NAME
is "USERNAME
".
PASSWORD
- A password, if one is used, for the user name.
ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
JDBC_ENGINE
- The name of the JDBC engine to use.
JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
CONFIG_FILES
- (Reserved for future use.)
INSTANCE_ID
- The instance ID to use.
JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer\'s root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
SECRET_ID
- The secret ID used for the secret manager of credentials.
CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection.
CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection.
CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection.
KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".
KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".
KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional).
KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
, "AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with sasl.kerberos.service.name
in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
These key-value pairs define parameters for the connection.
', ], ], 'ConnectionPropertyKey' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$key' => NULL, ], ], 'ConnectionStatus' => [ 'base' => NULL, 'refs' => [ 'Connection$Status' => 'The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.
', ], ], 'ConnectionType' => [ 'base' => NULL, 'refs' => [ 'Connection$ConnectionType' => 'The type of the connection. Currently, SFTP is not supported.
', 'ConnectionInput$ConnectionType' => 'The type of the connection. Currently, these types are supported:
JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).
JDBC
Connections use the following ConnectionParameters.
Required: All of (HOST
, PORT
, JDBC_ENGINE
) or JDBC_CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
Optional: JDBC_ENFORCE_SSL
, CUSTOM_JDBC_CERT
, CUSTOM_JDBC_CERT_STRING
, SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
KAFKA
- Designates a connection to an Apache Kafka streaming platform.
KAFKA
Connections use the following ConnectionParameters.
Required: KAFKA_BOOTSTRAP_SERVERS
.
Optional: KAFKA_SSL_ENABLED
, KAFKA_CUSTOM_CERT
, KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL with KAFKA
.
Optional: KAFKA_CLIENT_KEYSTORE
, KAFKA_CLIENT_KEYSTORE_PASSWORD
, KAFKA_CLIENT_KEY_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL in KAFKA
.
Optional: KAFKA_SASL_MECHANISM
. Can be specified as SCRAM-SHA-512
, GSSAPI
, or AWS_MSK_IAM
.
Optional: KAFKA_SASL_SCRAM_USERNAME
, KAFKA_SASL_SCRAM_PASSWORD
, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA
.
Optional: KAFKA_SASL_GSSAPI_KEYTAB
, KAFKA_SASL_GSSAPI_KRB5_CONF
, KAFKA_SASL_GSSAPI_SERVICE
, KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication with KAFKA
.
MONGODB
- Designates a connection to a MongoDB document database.
MONGODB
Connections use the following ConnectionParameters.
Required: CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
SALESFORCE
- Designates a connection to Salesforce using OAuth authencation.
Requires the AuthenticationConfiguration
member to be configured.
NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
MARKETPLACE
Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE
, CONNECTOR_URL
, CONNECTOR_CLASS_NAME
, CONNECTION_URL
.
Required for JDBC
CONNECTOR_TYPE
connections: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
SFTP
is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
', 'GetConnectionsFilter$ConnectionType' => 'The type of connections to return. Currently, SFTP is not supported.
', ], ], 'ConnectionsList' => [ 'base' => 'Specifies the connections used by a job.
', 'refs' => [ 'CreateJobRequest$Connections' => 'The connections used for this job.
', 'CreateSessionRequest$Connections' => 'The number of connections to use for the session.
', 'Job$Connections' => 'The connections used for this job.
', 'JobUpdate$Connections' => 'The connections used for this job.
', 'Session$Connections' => 'The number of connections used for the session.
', ], ], 'ConnectorDataSource' => [ 'base' => 'Specifies a source generated with standard connection options.
', 'refs' => [ 'CodeGenConfigurationNode$ConnectorDataSource' => 'Specifies a source generated with standard connection options.
', ], ], 'ConnectorDataTarget' => [ 'base' => 'Specifies a target generated with standard connection options.
', 'refs' => [ 'CodeGenConfigurationNode$ConnectorDataTarget' => 'Specifies a target generated with standard connection options.
', ], ], 'ConnectorOptions' => [ 'base' => NULL, 'refs' => [ 'ConnectorDataSource$Data' => 'A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
', 'ConnectorDataTarget$Data' => 'A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
', ], ], 'ContextKey' => [ 'base' => NULL, 'refs' => [ 'AdditionalContextMap$key' => NULL, ], ], 'ContextValue' => [ 'base' => NULL, 'refs' => [ 'AdditionalContextMap$value' => NULL, ], ], 'ContextWords' => [ 'base' => NULL, 'refs' => [ 'CreateCustomEntityTypeRequest$ContextWords' => 'A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
', 'CustomEntityType$ContextWords' => 'A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
', 'GetCustomEntityTypeResponse$ContextWords' => 'A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
', ], ], 'Crawl' => [ 'base' => 'The details of a crawl in the workflow.
', 'refs' => [ 'CrawlList$member' => NULL, ], ], 'CrawlId' => [ 'base' => NULL, 'refs' => [ 'CrawlerHistory$CrawlId' => 'A UUID identifier for each crawl.
', ], ], 'CrawlList' => [ 'base' => NULL, 'refs' => [ 'CrawlerNodeDetails$Crawls' => 'A list of crawls represented by the crawl node.
', ], ], 'CrawlState' => [ 'base' => NULL, 'refs' => [ 'Condition$CrawlState' => 'The state of the crawler to which this condition applies.
', 'Crawl$State' => 'The state of the crawler.
', ], ], 'Crawler' => [ 'base' => 'Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the Glue Data Catalog.
', 'refs' => [ 'CrawlerList$member' => NULL, 'GetCrawlerResponse$Crawler' => 'The metadata for the specified crawler.
', ], ], 'CrawlerConfiguration' => [ 'base' => NULL, 'refs' => [ 'Crawler$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', 'CreateCrawlerRequest$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', 'UpdateCrawlerRequest$Configuration' => 'Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Setting crawler configuration options.
', ], ], 'CrawlerHistory' => [ 'base' => 'Contains the information for a run of a crawler.
', 'refs' => [ 'CrawlerHistoryList$member' => NULL, ], ], 'CrawlerHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListCrawlsResponse$Crawls' => 'A list of CrawlerHistory
objects representing the crawl runs that meet your criteria.
The state of the crawl.
', ], ], 'CrawlerLineageSettings' => [ 'base' => NULL, 'refs' => [ 'LineageConfiguration$CrawlerLineageSettings' => 'Specifies whether data lineage is enabled for the crawler. Valid values are:
ENABLE: enables data lineage for the crawler
DISABLE: disables data lineage for the crawler
A list of crawler definitions.
', 'GetCrawlersResponse$Crawlers' => 'A list of crawler metadata.
', ], ], 'CrawlerMetrics' => [ 'base' => 'Metrics for a specified crawler.
', 'refs' => [ 'CrawlerMetricsList$member' => NULL, ], ], 'CrawlerMetricsList' => [ 'base' => NULL, 'refs' => [ 'GetCrawlerMetricsResponse$CrawlerMetricsList' => 'A list of metrics for the specified crawler.
', ], ], 'CrawlerNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetCrawlersRequest$CrawlerNames' => 'A list of crawler names, which might be the names returned from the ListCrawlers
operation.
A list of names of crawlers that were not found.
', 'GetCrawlerMetricsRequest$CrawlerNameList' => 'A list of the names of crawlers about which to retrieve metrics.
', 'ListCrawlersResponse$CrawlerNames' => 'The names of all crawlers in the account, or the crawlers with the specified tags.
', ], ], 'CrawlerNodeDetails' => [ 'base' => 'The details of a Crawler node present in the workflow.
', 'refs' => [ 'Node$CrawlerDetails' => 'Details of the crawler when the node represents a crawler.
', ], ], 'CrawlerNotRunningException' => [ 'base' => 'The specified crawler is not running.
', 'refs' => [], ], 'CrawlerRunningException' => [ 'base' => 'The operation cannot be performed because the crawler is already running.
', 'refs' => [], ], 'CrawlerSecurityConfiguration' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$SecurityConfiguration' => 'Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
', 'Crawler$CrawlerSecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used by this crawler.
The name of the SecurityConfiguration
structure to be used by this crawler.
The name of the SecurityConfiguration
structure to be used by this crawler.
Indicates whether the crawler is running, or whether a run is pending.
', ], ], 'CrawlerStoppingException' => [ 'base' => 'The specified crawler is stopping.
', 'refs' => [], ], 'CrawlerTargets' => [ 'base' => 'Specifies data stores to crawl.
', 'refs' => [ 'Crawler$Targets' => 'A collection of targets to crawl.
', 'CreateCrawlerRequest$Targets' => 'A list of collection of targets to crawl.
', 'UpdateCrawlerRequest$Targets' => 'A list of targets to crawl.
', ], ], 'CrawlsFilter' => [ 'base' => 'A list of fields, comparators and value that you can use to filter the crawler runs for a specified crawler.
', 'refs' => [ 'CrawlsFilterList$member' => NULL, ], ], 'CrawlsFilterList' => [ 'base' => NULL, 'refs' => [ 'ListCrawlsRequest$Filters' => 'Filters the crawls by the criteria you specify in a list of CrawlsFilter
objects.
Specifies a custom CSV classifier for CreateClassifier
to create.
A CsvClassifier
object specifying the classifier to create.
Specifies a grok
classifier for CreateClassifier
to create.
A GrokClassifier
object specifying the classifier to create.
Specifies a JSON classifier for CreateClassifier
to create.
A JsonClassifier
object specifying the classifier to create.
Request to create a new session.
', 'refs' => [], ], 'CreateSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableOptimizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableOptimizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUsageProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUsageProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateXMLClassifierRequest' => [ 'base' => 'Specifies an XML classifier for CreateClassifier
to create.
An XMLClassifier
object specifying the classifier to create.
The date and time the registry was created.
', 'GetSchemaByDefinitionResponse$CreatedTime' => 'The date and time the schema was created.
', 'GetSchemaResponse$CreatedTime' => 'The date and time the schema was created.
', 'GetSchemaVersionResponse$CreatedTime' => 'The date and time the schema version was created.
', 'MetadataInfo$CreatedTime' => 'The time at which the entry was created.
', 'OtherMetadataValueListItem$CreatedTime' => 'The time at which the entry was created.
', 'RegistryListItem$CreatedTime' => 'The data the registry was created.
', 'SchemaListItem$CreatedTime' => 'The date and time that a schema was created.
', 'SchemaVersionListItem$CreatedTime' => 'The date and time the schema version was created.
', ], ], 'CronExpression' => [ 'base' => NULL, 'refs' => [ 'CreateCrawlerRequest$Schedule' => 'A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
The updated cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
A classifier for custom CSV
content.
A classifier for comma-separated values (CSV).
', ], ], 'CsvColumnDelimiter' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', 'CsvClassifier$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', 'UpdateCsvClassifierRequest$Delimiter' => 'A custom symbol to denote what separates each column entry in the row.
', ], ], 'CsvHeader' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Header' => 'A list of strings representing column names.
', 'CsvClassifier$Header' => 'A list of strings representing column names.
', 'UpdateCsvClassifierRequest$Header' => 'A list of strings representing column names.
', ], ], 'CsvHeaderOption' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', 'CsvClassifier$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', 'UpdateCsvClassifierRequest$ContainsHeader' => 'Indicates whether the CSV file contains a header.
', ], ], 'CsvQuoteSymbol' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.
', 'CsvClassifier$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
', 'UpdateCsvClassifierRequest$QuoteSymbol' => 'A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.
', ], ], 'CsvSerdeOption' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$Serde' => 'Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe
, LazySimpleSerDe
, and None
. You can specify the None
value when you want the crawler to do the detection.
Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe
, LazySimpleSerDe
, and None
. You can specify the None
value when you want the crawler to do the detection.
Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe
, LazySimpleSerDe
, and None
. You can specify the None
value when you want the crawler to do the detection.
Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
', 'refs' => [ 'CodeGenConfigurationNode$CustomCode' => 'Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
', ], ], 'CustomDatatypes' => [ 'base' => NULL, 'refs' => [ 'CreateCsvClassifierRequest$CustomDatatypes' => 'Creates a list of supported custom datatypes.
', 'CsvClassifier$CustomDatatypes' => 'A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
', 'UpdateCsvClassifierRequest$CustomDatatypes' => 'Specifies a list of supported custom datatypes.
', ], ], 'CustomEntityType' => [ 'base' => 'An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.
', 'refs' => [ 'CustomEntityTypes$member' => NULL, ], ], 'CustomEntityTypeNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomEntityTypesRequest$Names' => 'A list of names of the custom patterns that you want to retrieve.
', 'BatchGetCustomEntityTypesResponse$CustomEntityTypesNotFound' => 'A list of the names of custom patterns that were not found.
', ], ], 'CustomEntityTypes' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomEntityTypesResponse$CustomEntityTypes' => 'A list of CustomEntityType
objects representing the custom patterns that have been created.
A list of CustomEntityType
objects representing custom patterns.
Optional custom grok patterns used by this classifier.
', 'GrokClassifier$CustomPatterns' => 'Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
', 'UpdateGrokClassifierRequest$CustomPatterns' => 'Optional custom grok patterns used by this classifier.
', ], ], 'DQAdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQualityMultiFrame$AdditionalOptions' => 'Options to configure runtime behavior of the transform.
', ], ], 'DQCompositeRuleEvaluationMethod' => [ 'base' => NULL, 'refs' => [ 'DataQualityEvaluationRunAdditionalRunOptions$CompositeRuleEvaluationMethod' => 'Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
', ], ], 'DQDLAliases' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQualityMultiFrame$AdditionalDataSources' => 'The aliases of all data sources except primary.
', ], ], 'DQDLString' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQuality$Ruleset' => 'The ruleset for your data quality evaluation.
', 'EvaluateDataQualityMultiFrame$Ruleset' => 'The ruleset for your data quality evaluation.
', ], ], 'DQResultsPublishingOptions' => [ 'base' => 'Options to configure how your data quality evaluation results are published.
', 'refs' => [ 'EvaluateDataQuality$PublishingOptions' => 'Options to configure how your results are published.
', 'EvaluateDataQualityMultiFrame$PublishingOptions' => 'Options to configure how your results are published.
', ], ], 'DQStopJobOnFailureOptions' => [ 'base' => 'Options to configure how your job will stop if your data quality evaluation fails.
', 'refs' => [ 'EvaluateDataQuality$StopJobOnFailureOptions' => 'Options to configure how your job will stop if your data quality evaluation fails.
', 'EvaluateDataQualityMultiFrame$StopJobOnFailureOptions' => 'Options to configure how your job will stop if your data quality evaluation fails.
', ], ], 'DQStopJobOnFailureTiming' => [ 'base' => NULL, 'refs' => [ 'DQStopJobOnFailureOptions$StopJobOnFailureTiming' => 'When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
', ], ], 'DQTransformOutput' => [ 'base' => NULL, 'refs' => [ 'EvaluateDataQuality$Output' => 'The output of your data quality evaluation.
', ], ], 'DagEdges' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$DagEdges' => 'A list of the edges in the DAG.
', 'GetDataflowGraphResponse$DagEdges' => 'A list of the edges in the resulting DAG.
', ], ], 'DagNodes' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$DagNodes' => 'A list of the nodes in the DAG.
', 'GetDataflowGraphResponse$DagNodes' => 'A list of the nodes in the resulting DAG.
', ], ], 'DataCatalogEncryptionSettings' => [ 'base' => 'Contains configuration information for maintaining Data Catalog security.
', 'refs' => [ 'GetDataCatalogEncryptionSettingsResponse$DataCatalogEncryptionSettings' => 'The requested security configuration.
', 'PutDataCatalogEncryptionSettingsRequest$DataCatalogEncryptionSettings' => 'The security configuration to set.
', ], ], 'DataFormat' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityInput$DataFormat' => 'The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The data format of the schema definition. Currently AVRO
, JSON
and PROTOBUF
are supported.
The Lake Formation principal.
', 'refs' => [ 'PrincipalPermissions$Principal' => 'The principal who is granted permissions.
', ], ], 'DataLakePrincipalString' => [ 'base' => NULL, 'refs' => [ 'DataLakePrincipal$DataLakePrincipalIdentifier' => 'An identifier for the Lake Formation principal.
', ], ], 'DataQualityAnalyzerResult' => [ 'base' => 'Describes the result of the evaluation of a data quality analyzer.
', 'refs' => [ 'DataQualityAnalyzerResults$member' => NULL, ], ], 'DataQualityAnalyzerResults' => [ 'base' => NULL, 'refs' => [ 'DataQualityResult$AnalyzerResults' => 'A list of DataQualityAnalyzerResult
objects representing the results for each analyzer.
A list of DataQualityAnalyzerResult
objects representing the results for each analyzer.
Additional run options you can specify for an evaluation run.
', 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$AdditionalRunOptions' => 'Additional run options you can specify for an evaluation run.
', 'StartDataQualityRulesetEvaluationRunRequest$AdditionalRunOptions' => 'Additional run options you can specify for an evaluation run.
', ], ], 'DataQualityMetricValues' => [ 'base' => 'Describes the data quality metric value according to the analysis of historical data.
', 'refs' => [ 'MetricBasedObservation$MetricValues' => 'An object of type DataQualityMetricValues
representing the analysis of the data quality metric value.
Describes the observation generated after evaluating the rules and analyzers.
', 'refs' => [ 'DataQualityObservations$member' => NULL, ], ], 'DataQualityObservationDescription' => [ 'base' => NULL, 'refs' => [ 'DataQualityObservation$Description' => 'A description of the data quality observation.
', ], ], 'DataQualityObservations' => [ 'base' => NULL, 'refs' => [ 'DataQualityResult$Observations' => 'A list of DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.
A list of DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.
Describes a data quality result.
', 'refs' => [ 'DataQualityResultsList$member' => NULL, ], ], 'DataQualityResultDescription' => [ 'base' => 'Describes a data quality result.
', 'refs' => [ 'DataQualityResultDescriptionList$member' => NULL, ], ], 'DataQualityResultDescriptionList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityResultsResponse$Results' => 'A list of DataQualityResultDescription
objects.
Criteria used to return data quality results.
', 'refs' => [ 'ListDataQualityResultsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityResultIdList' => [ 'base' => NULL, 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$ResultIds' => 'A list of result IDs for the data quality results for the run.
', ], ], 'DataQualityResultIds' => [ 'base' => NULL, 'refs' => [ 'BatchGetDataQualityResultRequest$ResultIds' => 'A list of unique result IDs for the data quality results.
', 'BatchGetDataQualityResultResponse$ResultsNotFound' => 'A list of result IDs for which results were not found.
', ], ], 'DataQualityResultsList' => [ 'base' => NULL, 'refs' => [ 'BatchGetDataQualityResultResponse$Results' => 'A list of DataQualityResult
objects representing the data quality results.
Describes the result of a data quality rule recommendation run.
', 'refs' => [ 'DataQualityRuleRecommendationRunList$member' => NULL, ], ], 'DataQualityRuleRecommendationRunFilter' => [ 'base' => 'A filter for listing data quality recommendation runs.
', 'refs' => [ 'ListDataQualityRuleRecommendationRunsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRuleRecommendationRunList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRuleRecommendationRunsResponse$Runs' => 'A list of DataQualityRuleRecommendationRunDescription
objects.
Describes the result of the evaluation of a data quality rule.
', 'refs' => [ 'DataQualityRuleResults$member' => NULL, ], ], 'DataQualityRuleResultDescription' => [ 'base' => NULL, 'refs' => [ 'DataQualityAnalyzerResult$Description' => 'A description of the data quality analyzer.
', 'DataQualityAnalyzerResult$EvaluationMessage' => 'An evaluation message.
', 'DataQualityRuleResult$Description' => 'A description of the data quality rule.
', 'DataQualityRuleResult$EvaluationMessage' => 'An evaluation message.
', ], ], 'DataQualityRuleResultStatus' => [ 'base' => NULL, 'refs' => [ 'DataQualityRuleResult$Result' => 'A pass or fail status for the rule.
', ], ], 'DataQualityRuleResults' => [ 'base' => NULL, 'refs' => [ 'DataQualityResult$RuleResults' => 'A list of DataQualityRuleResult
objects representing the results for each rule.
A list of DataQualityRuleResult
objects representing the results for each rule.
Describes the result of a data quality ruleset evaluation run.
', 'refs' => [ 'DataQualityRulesetEvaluationRunList$member' => NULL, ], ], 'DataQualityRulesetEvaluationRunFilter' => [ 'base' => 'The filter criteria.
', 'refs' => [ 'ListDataQualityRulesetEvaluationRunsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRulesetEvaluationRunList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRulesetEvaluationRunsResponse$Runs' => 'A list of DataQualityRulesetEvaluationRunDescription
objects representing data quality ruleset runs.
The criteria used to filter data quality rulesets.
', 'refs' => [ 'ListDataQualityRulesetsRequest$Filter' => 'The filter criteria.
', ], ], 'DataQualityRulesetList' => [ 'base' => NULL, 'refs' => [ 'ListDataQualityRulesetsResponse$Rulesets' => 'A paginated list of rulesets for the specified list of Glue tables.
', ], ], 'DataQualityRulesetListDetails' => [ 'base' => 'Describes a data quality ruleset returned by GetDataQualityRuleset
.
A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'GetDataQualityRuleRecommendationRunResponse$RecommendedRuleset' => 'When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
', 'GetDataQualityRulesetResponse$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'UpdateDataQualityRulesetRequest$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', 'UpdateDataQualityRulesetResponse$Ruleset' => 'A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
', ], ], 'DataQualityTargetTable' => [ 'base' => 'An object representing an Glue table.
', 'refs' => [ 'CreateDataQualityRulesetRequest$TargetTable' => 'A target table associated with the data quality ruleset.
', 'DataQualityRulesetFilterCriteria$TargetTable' => 'The name and database name of the target table.
', 'DataQualityRulesetListDetails$TargetTable' => 'An object representing an Glue table.
', 'GetDataQualityRulesetResponse$TargetTable' => 'The name and database name of the target table.
', ], ], 'DataSource' => [ 'base' => 'A data source (an Glue table) for which you want data quality results.
', 'refs' => [ 'DataQualityResult$DataSource' => 'The table associated with the data quality result, if any.
', 'DataQualityResultDescription$DataSource' => 'The table name associated with the data quality result.
', 'DataQualityResultFilterCriteria$DataSource' => 'Filter results by the specified data source. For example, retrieving all results for an Glue table.
', 'DataQualityRuleRecommendationRunDescription$DataSource' => 'The data source (Glue table) associated with the recommendation run.
', 'DataQualityRuleRecommendationRunFilter$DataSource' => 'Filter based on a specified data source (Glue table).
', 'DataQualityRulesetEvaluationRunDescription$DataSource' => 'The data source (an Glue table) associated with the run.
', 'DataQualityRulesetEvaluationRunFilter$DataSource' => 'Filter based on a data source (an Glue table) associated with the run.
', 'DataSourceMap$value' => NULL, 'GetDataQualityResultResponse$DataSource' => 'The table associated with the data quality result, if any.
', 'GetDataQualityRuleRecommendationRunResponse$DataSource' => 'The data source (an Glue table) associated with this run.
', 'GetDataQualityRulesetEvaluationRunResponse$DataSource' => 'The data source (an Glue table) associated with this evaluation run.
', 'StartDataQualityRuleRecommendationRunRequest$DataSource' => 'The data source (Glue table) associated with this run.
', 'StartDataQualityRulesetEvaluationRunRequest$DataSource' => 'The data source (Glue table) associated with this run.
', ], ], 'DataSourceMap' => [ 'base' => NULL, 'refs' => [ 'GetDataQualityRulesetEvaluationRunResponse$AdditionalDataSources' => 'A map of reference strings to additional data sources you can specify for an evaluation run.
', 'StartDataQualityRulesetEvaluationRunRequest$AdditionalDataSources' => 'A map of reference strings to additional data sources you can specify for an evaluation run.
', ], ], 'Database' => [ 'base' => 'The Database
object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.
The definition of the specified database in the Data Catalog.
', ], ], 'DatabaseAttributes' => [ 'base' => NULL, 'refs' => [ 'DatabaseAttributesList$member' => NULL, ], ], 'DatabaseAttributesList' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$AttributesToGet' => 'Specifies the database fields returned by the GetDatabases
call. This parameter doesn’t accept an empty list. The request must include the NAME
.
A structure that describes a target database for resource linking.
', 'refs' => [ 'Database$TargetDatabase' => 'A DatabaseIdentifier
structure that describes a target database for resource linking.
A DatabaseIdentifier
structure that describes a target database for resource linking.
The structure used to create or update a database.
', 'refs' => [ 'CreateDatabaseRequest$DatabaseInput' => 'The metadata for the database.
', 'UpdateDatabaseRequest$DatabaseInput' => 'A DatabaseInput
object specifying the new definition of the metadata database in the catalog.
A list of Database
objects from the specified catalog.
The database where the table resides.
', 'Crawler$DatabaseName' => 'The name of the database in which the crawler\'s output is stored.
', 'CreateCrawlerRequest$DatabaseName' => 'The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*
.
The name of the database where the table resides.
', 'StopColumnStatisticsTaskRunRequest$DatabaseName' => 'The name of the database where the table resides.
', 'UpdateCrawlerRequest$DatabaseName' => 'The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*
.
A structure representing the datatype of the value.
', 'refs' => [ 'NullValueField$Datatype' => 'The datatype of the value.
', ], ], 'DateColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for timestamp data columns.
', 'refs' => [ 'ColumnStatisticsData$DateColumnStatisticsData' => 'Date column statistics data.
', ], ], 'DecimalColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for fixed-point number data columns.
', 'refs' => [ 'ColumnStatisticsData$DecimalColumnStatisticsData' => 'Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two\'s complement representations of the decimal\'s unscaled value.
', ], ], 'DecimalNumber' => [ 'base' => 'Contains a numeric value in decimal format.
', 'refs' => [ 'DecimalColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DecimalColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'DeleteBehavior' => [ 'base' => NULL, 'refs' => [ 'SchemaChangePolicy$DeleteBehavior' => 'The deletion behavior when the crawler finds a deleted object.
', ], ], 'DeleteBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionNameList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionRequest$ConnectionNameList' => 'A list of names of the connections to delete.
', ], ], 'DeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomEntityTypeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityRulesetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDataQualityRulesetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDatabaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDevEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDevEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMLTransformRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMLTransformResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionIndexRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionIndexResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistryInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRegistryResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSchemaVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSecurityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableOptimizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableOptimizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTableVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUsageProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUsageProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeltaTarget' => [ 'base' => 'Specifies a Delta data store to crawl one or more Delta tables.
', 'refs' => [ 'DeltaTargetList$member' => NULL, ], ], 'DeltaTargetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3DeltaDirectTarget$Compression' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Specifies Delta data store targets.
', ], ], 'DescriptionString' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$ErrorMessage' => 'The error message for the job.
', 'Connection$Description' => 'The description of the connection.
', 'ConnectionInput$Description' => 'The description of the connection.
', 'Crawl$ErrorMessage' => 'The error message associated with the crawl.
', 'Crawler$Description' => 'A description of the crawler.
', 'CrawlerHistory$ErrorMessage' => 'If an error occurred, the error message associated with the crawl.
', 'CreateCrawlerRequest$Description' => 'A description of the new crawler.
', 'CreateDataQualityRulesetRequest$Description' => 'A description of the data quality ruleset.
', 'CreateJobRequest$Description' => 'Description of the job being defined.
', 'CreateMLTransformRequest$Description' => 'A description of the machine learning transform that is being defined. The default is an empty string.
', 'CreateRegistryInput$Description' => 'A description of the registry. If description is not provided, there will not be any default value for this.
', 'CreateRegistryResponse$Description' => 'A description of the registry.
', 'CreateSchemaInput$Description' => 'An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
', 'CreateSchemaResponse$Description' => 'A description of the schema if specified when created.
', 'CreateSessionRequest$Description' => 'The description of the session.
', 'CreateTriggerRequest$Description' => 'A description of the new trigger.
', 'CreateUsageProfileRequest$Description' => 'A description of the usage profile.
', 'DataQualityRulesetFilterCriteria$Description' => 'The description of the ruleset filter criteria.
', 'DataQualityRulesetListDetails$Description' => 'A description of the data quality ruleset.
', 'Database$Description' => 'A description of the database.
', 'DatabaseInput$Description' => 'A description of the database.
', 'ErrorDetail$ErrorMessage' => 'A message describing the error.
', 'GetDataQualityRulesetResponse$Description' => 'A description of the ruleset.
', 'GetMLTransformResponse$Description' => 'A description of the transform.
', 'GetRegistryResponse$Description' => 'A description of the registry.
', 'GetSchemaResponse$Description' => 'A description of schema if specified when created
', 'GetUsageProfileResponse$Description' => 'A description of the usage profile.
', 'GlueTableAdditionalOptions$value' => NULL, 'Job$Description' => 'A description of the job.
', 'JobUpdate$Description' => 'Description of the job being defined.
', 'LastCrawlInfo$ErrorMessage' => 'If an error occurred, the error information about the last crawl.
', 'MLTransform$Description' => 'A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
', 'RegistryListItem$Description' => 'A description of the registry.
', 'SchemaListItem$Description' => 'A description for the schema.
', 'Session$ErrorMessage' => 'The error message displayed during the session.
', 'Session$Description' => 'The description of the session.
', 'Table$Description' => 'A description of the table.
', 'TableInput$Description' => 'A description of the table.
', 'Trigger$Description' => 'A description of this trigger.
', 'TriggerUpdate$Description' => 'A description of this trigger.
', 'UpdateDataQualityRulesetRequest$Description' => 'A description of the ruleset.
', 'UpdateDataQualityRulesetResponse$Description' => 'A description of the ruleset.
', 'UpdateMLTransformRequest$Description' => 'A description of the transform. The default is an empty string.
', 'UpdateRegistryInput$Description' => 'A description of the registry. If description is not provided, this field will not be updated.
', 'UpdateSchemaInput$Description' => 'The new description for the schema.
', 'UpdateUsageProfileRequest$Description' => 'A description of the usage profile.
', 'UsageProfileDefinition$Description' => 'A description of the usage profile.
', ], ], 'DescriptionStringRemovable' => [ 'base' => NULL, 'refs' => [ 'UpdateCrawlerRequest$Description' => 'A description of the new crawler.
', ], ], 'DevEndpoint' => [ 'base' => 'A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.
', 'refs' => [ 'DevEndpointList$member' => NULL, 'GetDevEndpointResponse$DevEndpoint' => 'A DevEndpoint
definition.
Custom libraries to be loaded into a development endpoint.
', 'refs' => [ 'UpdateDevEndpointRequest$CustomLibraries' => 'Custom Python or Java libraries to be loaded in the DevEndpoint
.
A list of DevEndpoint
definitions.
A list of DevEndpoint
definitions.
The names of all the DevEndpoint
s in the account, or the DevEndpoint
s with the specified tags.
The list of DevEndpoint
names, which might be the names returned from the ListDevEndpoint
operation.
A list of DevEndpoints
not found.
Specifies the direct JDBC source connection.
', 'refs' => [ 'CodeGenConfigurationNode$DirectJDBCSource' => NULL, ], ], 'DirectKafkaSource' => [ 'base' => 'Specifies an Apache Kafka data store.
', 'refs' => [ 'CodeGenConfigurationNode$DirectKafkaSource' => 'Specifies an Apache Kafka data store.
', ], ], 'DirectKinesisSource' => [ 'base' => 'Specifies a direct Amazon Kinesis data source.
', 'refs' => [ 'CodeGenConfigurationNode$DirectKinesisSource' => 'Specifies a direct Amazon Kinesis data source.
', ], ], 'DirectSchemaChangePolicy' => [ 'base' => 'A policy that specifies update behavior for the crawler.
', 'refs' => [ 'S3DeltaDirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3DirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3GlueParquetTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', 'S3HudiDirectTarget$SchemaChangePolicy' => 'A policy that specifies update behavior for the crawler.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'DoubleColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DoubleColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'DoubleColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for floating-point number data columns.
', 'refs' => [ 'ColumnStatisticsData$DoubleColumnStatisticsData' => 'Double column statistics data.
', ], ], 'DoubleValue' => [ 'base' => NULL, 'refs' => [ 'Session$Progress' => 'The code execution progress of the session.
', 'Statement$Progress' => 'The code execution progress.
', ], ], 'DropDuplicates' => [ 'base' => 'Specifies a transform that removes rows of repeating data from a data set.
', 'refs' => [ 'CodeGenConfigurationNode$DropDuplicates' => 'Specifies a transform that removes rows of repeating data from a data set.
', ], ], 'DropFields' => [ 'base' => 'Specifies a transform that chooses the data property keys that you want to drop.
', 'refs' => [ 'CodeGenConfigurationNode$DropFields' => 'Specifies a transform that chooses the data property keys that you want to drop.
', ], ], 'DropNullFields' => [ 'base' => 'Specifies a transform that removes columns from the dataset if all values in the column are \'null\'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
', 'refs' => [ 'CodeGenConfigurationNode$DropNullFields' => 'Specifies a transform that removes columns from the dataset if all values in the column are \'null\'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
', ], ], 'DynamicTransform' => [ 'base' => 'Specifies the set of parameters needed to perform the dynamic transform.
', 'refs' => [ 'CodeGenConfigurationNode$DynamicTransform' => 'Specifies a custom visual transform created by a user.
', ], ], 'DynamoDBCatalogSource' => [ 'base' => 'Specifies a DynamoDB data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$DynamoDBCatalogSource' => 'Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
', ], ], 'DynamoDBTarget' => [ 'base' => 'Specifies an Amazon DynamoDB table to crawl.
', 'refs' => [ 'DynamoDBTargetList$member' => NULL, ], ], 'DynamoDBTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$DynamoDBTargets' => 'Specifies Amazon DynamoDB targets.
', ], ], 'Edge' => [ 'base' => 'An edge represents a directed connection between two Glue components that are part of the workflow the edge belongs to.
', 'refs' => [ 'EdgeList$member' => NULL, ], ], 'EdgeList' => [ 'base' => NULL, 'refs' => [ 'WorkflowGraph$Edges' => 'A list of all the directed connections between the nodes belonging to the workflow.
', ], ], 'EnableAdditionalMetadata' => [ 'base' => NULL, 'refs' => [ 'JdbcTarget$EnableAdditionalMetadata' => 'Specify a value of RAWTYPES
or COMMENTS
to enable additional metadata in table responses. RAWTYPES
provides the native-level datatype. COMMENTS
provides comments associated with a column or table in the database.
If you do not need additional metadata, keep the field empty.
', ], ], 'EnableHybridValues' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$EnableHybrid' => 'If \'TRUE\'
, indicates that you are using both methods to grant cross-account access to Data Catalog resources:
By directly updating the resource policy with PutResourePolicy
By using the Grant permissions command on the Amazon Web Services Management Console.
Must be set to \'TRUE\'
if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is \'FALSE\'.
Specifies the column on the data set on which the aggregation function will be applied.
', 'FilterValue$Value' => 'The value to be associated.
', 'GlueStudioPathList$member' => NULL, 'JDBCConnectorOptions$JobBookmarkKeys' => 'The name of the job bookmark keys on which to sort.
', 'Mapping$FromPath' => 'The table or column to be modified.
', 'PIIDetection$EntityTypesToDetect' => 'Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
', 'RenameField$SourcePath' => 'A JSON path to a variable in the data structure for the source data.
', 'RenameField$TargetPath' => 'A JSON path to a variable in the data structure for the target data.
', 'S3CsvSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3CsvSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'S3DeltaSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3HudiSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3JsonSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3JsonSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'S3ParquetSource$Paths' => 'A list of the Amazon S3 paths to read from.
', 'S3ParquetSource$Exclusions' => 'A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\\"**.pdf\\"]" excludes all PDF files.
', 'TransformConfigParameter$Value' => 'Specifies the value of the parameter in the config file of the dynamic transform.
', ], ], 'EnclosedInStringPropertiesMinOne' => [ 'base' => NULL, 'refs' => [ 'UpsertRedshiftTargetOptions$UpsertKeys' => 'The keys used to determine whether to perform an update or insert.
', ], ], 'EnclosedInStringProperty' => [ 'base' => NULL, 'refs' => [ 'AdditionalOptions$key' => NULL, 'AdditionalOptions$value' => NULL, 'AmazonRedshiftNodeData$TempDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'AthenaConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'AthenaConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'AthenaConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
', 'AthenaConnectorSource$SchemaName' => 'The name of the Cloudwatch log group to read from. For example, /aws-glue/jobs/output
.
The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
', 'BasicCatalogTarget$Table' => 'The table that defines the schema of your output data. This table must already exist in the Data Catalog.
', 'CatalogDeltaSource$Database' => 'The name of the database to read from.
', 'CatalogDeltaSource$Table' => 'The name of the table in the database to read from.
', 'CatalogHudiSource$Database' => 'The name of the database to read from.
', 'CatalogHudiSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKafkaSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKafkaSource$Database' => 'The name of the database to read from.
', 'CatalogKinesisSource$Table' => 'The name of the table in the database to read from.
', 'CatalogKinesisSource$Database' => 'The name of the database to read from.
', 'CatalogSource$Database' => 'The name of the database to read from.
', 'CatalogSource$Table' => 'The name of the table in the database to read from.
', 'ConnectorDataSource$ConnectionType' => 'The connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:
opensearch
azuresql
azurecosmos
bigquery
saphana
teradata
vertica
The connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:
opensearch
azuresql
azurecosmos
bigquery
saphana
teradata
vertica
The name defined for the custom code node class.
', 'DQDLAliases$value' => NULL, 'DQResultsPublishingOptions$ResultsS3Prefix' => 'The Amazon S3 prefix prepended to the results.
', 'DirectJDBCSource$Database' => 'The database of the JDBC source connection.
', 'DirectJDBCSource$Table' => 'The table of the JDBC source connection.
', 'DirectJDBCSource$ConnectionName' => 'The connection name of the JDBC source.
', 'DirectJDBCSource$RedshiftTmpDir' => 'The temp directory of the JDBC Redshift source.
', 'DirectSchemaChangePolicy$Table' => 'Specifies the table in the database that the schema change policy applies to.
', 'DirectSchemaChangePolicy$Database' => 'Specifies the database that the schema change policy applies to.
', 'DynamicTransform$Name' => 'Specifies the name of the dynamic transform.
', 'DynamicTransform$TransformName' => 'Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
', 'DynamicTransform$FunctionName' => 'Specifies the name of the function of the dynamic transform.
', 'DynamicTransform$Path' => 'Specifies the path of the dynamic transform source and config files.
', 'DynamicTransform$Version' => 'This field is not used and will be deprecated in future release.
', 'DynamoDBCatalogSource$Database' => 'The name of the database to read from.
', 'DynamoDBCatalogSource$Table' => 'The name of the table in the database to read from.
', 'EnclosedInStringProperties$member' => NULL, 'EnclosedInStringPropertiesMinOne$member' => NULL, 'FillMissingValues$ImputedPath' => 'A JSON path to a variable in the data structure for the dataset that is imputed.
', 'FillMissingValues$FilledPath' => 'A JSON path to a variable in the data structure for the dataset that is filled.
', 'GovernedCatalogSource$Database' => 'The database to read from.
', 'GovernedCatalogSource$Table' => 'The database table to read from.
', 'GovernedCatalogSource$PartitionPredicate' => 'Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to ""
– empty by default.
The name of the table in the database to write to.
', 'GovernedCatalogTarget$Database' => 'The name of the database to write to.
', 'JDBCConnectorOptions$FilterPredicate' => 'Extra condition clause to filter data from source. For example:
BillingCity=\'Mountain View\'
When using a query instead of a table name, you should validate that the query works with the specified filterPredicate
.
The name of an integer column that is used for partitioning. This option works only when it\'s included with lowerBound
, upperBound
, and numPartitions
. This option works the same way as in the Spark SQL JDBC reader.
Specifies an ascending or descending sort order.
', 'JDBCConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'JDBCConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'JDBCConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
', 'JDBCConnectorTarget$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'JDBCConnectorTarget$ConnectorName' => 'The name of a connector that will be used.
', 'JDBCConnectorTarget$ConnectionType' => 'The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
', 'JoinColumn$From' => 'The column to be joined.
', 'KafkaStreamingSourceOptions$BootstrapServers' => 'A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
The protocol used to communicate with brokers. The possible values are "SSL"
or "PLAINTEXT"
.
The name of the connection.
', 'KafkaStreamingSourceOptions$TopicName' => 'The topic name as specified in Apache Kafka. You must specify at least one of "topicName"
, "assign"
or "subscribePattern"
.
The specific TopicPartitions
to consume. You must specify at least one of "topicName"
, "assign"
or "subscribePattern"
.
A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName"
, "assign"
or "subscribePattern"
.
An optional classification.
', 'KafkaStreamingSourceOptions$Delimiter' => 'Specifies the delimiter character.
', 'KafkaStreamingSourceOptions$StartingOffsets' => 'The starting position in the Kafka topic to read data from. The possible values are "earliest"
or "latest"
. The default value is "latest"
.
The end point when a batch query is ended. Possible values are either "latest"
or a JSON string that specifies an ending offset for each TopicPartition
.
When this option is set to \'true\', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KafkaStreamingSourceOptions$EmitConsumerLagMetrics' => 'When this option is set to \'true\', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric\'s name is "glue.driver.streaming.maxConsumerLagInMs". The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KinesisStreamingSourceOptions$EndpointUrl' => 'The URL of the Kinesis endpoint.
', 'KinesisStreamingSourceOptions$StreamName' => 'The name of the Kinesis data stream.
', 'KinesisStreamingSourceOptions$Classification' => 'An optional classification.
', 'KinesisStreamingSourceOptions$Delimiter' => 'Specifies the delimiter character.
', 'KinesisStreamingSourceOptions$StreamArn' => 'The Amazon Resource Name (ARN) of the Kinesis data stream.
', 'KinesisStreamingSourceOptions$RoleArn' => 'The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName"
.
An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN"
.
When this option is set to \'true\', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'KinesisStreamingSourceOptions$EmitConsumerLagMetrics' => 'When this option is set to \'true\', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric\'s name is "glue.driver.streaming.maxConsumerLagInMs". The default value is \'false\'. This option is supported in Glue version 4.0 or later.
', 'Mapping$ToKey' => 'After the apply mapping, what the name of the column should be. Can be the same as FromPath
.
The type of the data to be modified.
', 'Mapping$ToType' => 'The data type that the data is to be modified to.
', 'MicrosoftSQLServerCatalogSource$Database' => 'The name of the database to read from.
', 'MicrosoftSQLServerCatalogSource$Table' => 'The name of the table in the database to read from.
', 'MicrosoftSQLServerCatalogTarget$Database' => 'The name of the database to write to.
', 'MicrosoftSQLServerCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'MySQLCatalogSource$Database' => 'The name of the database to read from.
', 'MySQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'MySQLCatalogTarget$Database' => 'The name of the database to write to.
', 'MySQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'NullValueField$Value' => 'The value of the null placeholder.
', 'Option$Value' => 'Specifies the value of the option.
', 'Option$Label' => 'Specifies the label of the option.
', 'Option$Description' => 'Specifies the description of the option.
', 'OracleSQLCatalogSource$Database' => 'The name of the database to read from.
', 'OracleSQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'OracleSQLCatalogTarget$Database' => 'The name of the database to write to.
', 'OracleSQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'PIIDetection$OutputColumnName' => 'Indicates the output column name that will contain any entity type detected in that row.
', 'PostgreSQLCatalogSource$Database' => 'The name of the database to read from.
', 'PostgreSQLCatalogSource$Table' => 'The name of the table in the database to read from.
', 'PostgreSQLCatalogTarget$Database' => 'The name of the database to write to.
', 'PostgreSQLCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'RecipeReference$RecipeArn' => 'The ARN of the DataBrew recipe.
', 'RedshiftSource$Database' => 'The database to read from.
', 'RedshiftSource$Table' => 'The database table to read from.
', 'RedshiftSource$RedshiftTmpDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'RedshiftSource$TmpDirIAMRole' => 'The IAM role with permissions.
', 'RedshiftTarget$Database' => 'The name of the database to write to.
', 'RedshiftTarget$Table' => 'The name of the table in the database to write to.
', 'RedshiftTarget$RedshiftTmpDir' => 'The Amazon S3 path where temporary data can be staged when copying out of the database.
', 'RedshiftTarget$TmpDirIAMRole' => 'The IAM role with permissions.
', 'RelationalCatalogSource$Database' => 'The name of the database to read from.
', 'RelationalCatalogSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogDeltaSource$Database' => 'The name of the database to read from.
', 'S3CatalogDeltaSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogHudiSource$Database' => 'The name of the database to read from.
', 'S3CatalogHudiSource$Table' => 'The name of the table in the database to read from.
', 'S3CatalogSource$Database' => 'The database to read from.
', 'S3CatalogSource$Table' => 'The database table to read from.
', 'S3CatalogSource$PartitionPredicate' => 'Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to ""
– empty by default.
The name of the table in the database to write to.
', 'S3CatalogTarget$Database' => 'The name of the database to write to.
', 'S3CsvSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles"
must be set to "inPartition"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none"
.
The name of the table in the database to write to.
', 'S3DeltaCatalogTarget$Database' => 'The name of the database to write to.
', 'S3DeltaDirectTarget$Path' => 'The Amazon S3 path of your Delta Lake data source to write to.
', 'S3DirectSourceAdditionalOptions$SamplePath' => 'If enabled, specifies the sample path.
', 'S3DirectTarget$Path' => 'A single Amazon S3 path to write to.
', 'S3DirectTarget$Compression' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
A single Amazon S3 path to write to.
', 'S3HudiCatalogTarget$Table' => 'The name of the table in the database to write to.
', 'S3HudiCatalogTarget$Database' => 'The name of the database to write to.
', 'S3HudiDirectTarget$Path' => 'The Amazon S3 path of your Hudi data source to write to.
', 'S3JsonSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles"
must be set to "inPartition"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none"
.
A JsonPath string defining the JSON data.
', 'S3ParquetSource$GroupSize' => 'The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, "groupFiles"
must be set to "inPartition"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to "none"
.
Not currently used.
', 'SparkConnectorSource$ConnectionName' => 'The name of the connection that is associated with the connector.
', 'SparkConnectorSource$ConnectorName' => 'The name of a connector that assists with accessing the data store in Glue Studio.
', 'SparkConnectorSource$ConnectionType' => 'The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
', 'SparkConnectorTarget$ConnectionName' => 'The name of a connection for an Apache Spark connector.
', 'SparkConnectorTarget$ConnectorName' => 'The name of an Apache Spark connector.
', 'SparkConnectorTarget$ConnectionType' => 'The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
', 'Spigot$Path' => 'A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
', 'TransformConfigParameter$Name' => 'Specifies the name of the parameter in the config file of the dynamic transform.
', 'TransformConfigParameter$ValidationRule' => 'Specifies the validation rule in the config file of the dynamic transform.
', 'TransformConfigParameter$ValidationMessage' => 'Specifies the validation message in the config file of the dynamic transform.
', 'UpsertRedshiftTargetOptions$TableLocation' => 'The physical location of the Redshift table.
', 'UpsertRedshiftTargetOptions$ConnectionName' => 'The name of the connection to use to write to Redshift.
', ], ], 'EnclosedInStringPropertyWithQuote' => [ 'base' => NULL, 'refs' => [ 'AthenaConnectorSource$ConnectionTable' => 'The name of the table in the data source.
', 'JDBCConnectorSource$ConnectionTable' => 'The name of the table in the data source.
', 'JDBCConnectorTarget$ConnectionTable' => 'The name of the table in the data target.
', 'S3CsvSource$Escaper' => 'Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none
. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\\n
, \\r
, \\t
, and \\0
).
A temporary name given to a table, or a column in a table.
', ], ], 'EncryptionAtRest' => [ 'base' => 'Specifies the encryption-at-rest configuration for the Data Catalog.
', 'refs' => [ 'DataCatalogEncryptionSettings$EncryptionAtRest' => 'Specifies the encryption-at-rest configuration for the Data Catalog.
', ], ], 'EncryptionConfiguration' => [ 'base' => 'Specifies an encryption configuration.
', 'refs' => [ 'CreateSecurityConfigurationRequest$EncryptionConfiguration' => 'The encryption configuration for the new security configuration.
', 'SecurityConfiguration$EncryptionConfiguration' => 'The encryption configuration associated with this security configuration.
', ], ], 'EntityNotFoundException' => [ 'base' => 'A specified entity does not exist
', 'refs' => [], ], 'ErrorByName' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionResponse$Errors' => 'A map of the names of connections that were not successfully deleted to error details.
', ], ], 'ErrorCodeString' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorCode' => 'The error code for an error.
', ], ], 'ErrorDetail' => [ 'base' => 'Contains details about an error.
', 'refs' => [ 'BatchGetTableOptimizerError$error' => 'An ErrorDetail
object containing code and message details about the error.
Specifies details about the error that was encountered.
', 'BatchUpdatePartitionFailureEntry$ErrorDetail' => 'The details about the batch update partition error.
', 'ColumnError$Error' => 'An error message with the reason for the failure of an operation.
', 'ColumnStatisticsError$Error' => 'An error message with the reason for the failure of an operation.
', 'ErrorByName$value' => NULL, 'PartitionError$ErrorDetail' => 'The details about the partition error.
', 'TableError$ErrorDetail' => 'The details about the error.
', 'TableVersionError$ErrorDetail' => 'The details about the error.
', ], ], 'ErrorDetails' => [ 'base' => 'An object containing error details.
', 'refs' => [ 'SchemaVersionErrorItem$ErrorDetails' => 'The details of the error for the schema version.
', ], ], 'ErrorMessageString' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorMessage' => 'The error message for an error.
', ], ], 'ErrorString' => [ 'base' => NULL, 'refs' => [ 'Blueprint$ErrorMessage' => 'An error message.
', 'JobRun$ErrorMessage' => 'An error message associated with this job run.
', 'WorkflowRun$ErrorMessage' => 'This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo
."
Specifies your data quality evaluation criteria.
', 'refs' => [ 'CodeGenConfigurationNode$EvaluateDataQuality' => 'Specifies your data quality evaluation criteria.
', ], ], 'EvaluateDataQualityMultiFrame' => [ 'base' => 'Specifies your data quality evaluation criteria.
', 'refs' => [ 'CodeGenConfigurationNode$EvaluateDataQualityMultiFrame' => 'Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
', ], ], 'EvaluatedMetricsMap' => [ 'base' => NULL, 'refs' => [ 'DataQualityAnalyzerResult$EvaluatedMetrics' => 'A map of metrics associated with the evaluation of the analyzer.
', 'DataQualityRuleResult$EvaluatedMetrics' => 'A map of metrics associated with the evaluation of the rule.
', ], ], 'EvaluationMetrics' => [ 'base' => 'Evaluation metrics provide an estimate of the quality of your machine learning transform.
', 'refs' => [ 'GetMLTransformResponse$EvaluationMetrics' => 'The latest evaluation metrics.
', 'MLTransform$EvaluationMetrics' => 'An EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'refs' => [ 'CreateTriggerRequest$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'Trigger$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', 'TriggerUpdate$EventBatchingCondition' => 'Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
', ], ], 'EventQueueArn' => [ 'base' => NULL, 'refs' => [ 'CatalogTarget$EventQueueArn' => 'A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs
.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue
.
A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs
.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue
.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
An execution property of a job.
', 'refs' => [ 'CreateJobRequest$ExecutionProperty' => 'An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
The amount of time (in seconds) that the run consumed resources.
', 'GetDataQualityRulesetEvaluationRunResponse$ExecutionTime' => 'The amount of time (in seconds) that the run consumed resources.
', 'GetMLTaskRunResponse$ExecutionTime' => 'The amount of time (in seconds) that the task run consumed resources.
', 'JobRun$ExecutionTime' => 'The amount of time (in seconds) that the job run consumed resources.
', 'TaskRun$ExecutionTime' => 'The amount of time (in seconds) that the task run consumed resources.
', ], ], 'ExistCondition' => [ 'base' => NULL, 'refs' => [ 'PutResourcePolicyRequest$PolicyExistsCondition' => 'A value of MUST_EXIST
is used to update a policy. A value of NOT_EXIST
is used to create a new policy. If a value of NONE
or a null value is used, the call does not depend on the existence of a policy.
Specifies configuration properties for an exporting labels task run.
', 'refs' => [ 'TaskRunProperties$ExportLabelsTaskRunProperties' => 'The configuration properties for an exporting labels task run.
', ], ], 'ExtendedString' => [ 'base' => NULL, 'refs' => [ 'CustomCode$Code' => 'The custom code that is used to perform the data transformation.
', ], ], 'FederatedDatabase' => [ 'base' => 'A database that points to an entity outside the Glue Data Catalog.
', 'refs' => [ 'Database$FederatedDatabase' => 'A FederatedDatabase
structure that references an entity outside the Glue Data Catalog.
A FederatedDatabase
structure that references an entity outside the Glue Data Catalog.
A federated resource already exists.
', 'refs' => [], ], 'FederatedTable' => [ 'base' => 'A table that points to an entity outside the Glue Data Catalog.
', 'refs' => [ 'Table$FederatedTable' => 'A FederatedTable
structure that references an entity outside the Glue Data Catalog.
A unique identifier for the federated database.
', 'FederatedTable$Identifier' => 'A unique identifier for the federated table.
', 'FederatedTable$DatabaseIdentifier' => 'A unique identifier for the federated database.
', ], ], 'FederationSourceErrorCode' => [ 'base' => NULL, 'refs' => [ 'FederationSourceException$FederationSourceErrorCode' => 'The error code of the problem.
', ], ], 'FederationSourceException' => [ 'base' => 'A federation source failed.
', 'refs' => [], ], 'FederationSourceRetryableException' => [ 'base' => 'A federation source failed, but the operation may be retried.
', 'refs' => [], ], 'FieldName' => [ 'base' => NULL, 'refs' => [ 'CrawlsFilter$FieldName' => 'A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:
CRAWL_ID
: A string representing the UUID identifier for a crawl.
STATE
: A string representing the state of the crawl.
START_TIME
and END_TIME
: The epoch timestamp in milliseconds.
DPU_HOUR
: The number of data processing unit (DPU) hours used for the crawl.
The source type.
', 'MappingEntry$TargetType' => 'The target type.
', ], ], 'FillMissingValues' => [ 'base' => 'Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
', 'refs' => [ 'CodeGenConfigurationNode$FillMissingValues' => 'Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
', ], ], 'Filter' => [ 'base' => 'Specifies a transform that splits a dataset into two, based on a filter condition.
', 'refs' => [ 'CodeGenConfigurationNode$Filter' => 'Specifies a transform that splits a dataset into two, based on a filter condition.
', ], ], 'FilterExpression' => [ 'base' => 'Specifies a filter expression.
', 'refs' => [ 'FilterExpressions$member' => NULL, ], ], 'FilterExpressions' => [ 'base' => NULL, 'refs' => [ 'Filter$Filters' => 'Specifies a filter expression.
', ], ], 'FilterLogicalOperator' => [ 'base' => NULL, 'refs' => [ 'Filter$LogicalOperator' => 'The operator used to filter rows by comparing the key value to a specified value.
', ], ], 'FilterOperation' => [ 'base' => NULL, 'refs' => [ 'FilterExpression$Operation' => 'The type of operation to perform in the expression.
', ], ], 'FilterOperator' => [ 'base' => NULL, 'refs' => [ 'CrawlsFilter$FilterOperator' => 'A defined comparator that operates on the value. The available operators are:
GT
: Greater than.
GE
: Greater than or equal to.
LT
: Less than.
LE
: Less than or equal to.
EQ
: Equal to.
NE
: Not equal to.
A regular expression pattern. If present, only those tables whose names match the pattern are returned.
', ], ], 'FilterValue' => [ 'base' => 'Represents a single entry in the list of values for a FilterExpression
.
The type of filter value.
', ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'FilterExpression$Values' => 'A list of filter values.
', ], ], 'FindMatchesMetrics' => [ 'base' => 'The evaluation metrics for the find matches algorithm. The quality of your machine learning transform is measured by getting your transform to predict some matches and comparing the results to known matches from the same dataset. The quality metrics are based on a subset of your data, so they are not precise.
', 'refs' => [ 'EvaluationMetrics$FindMatchesMetrics' => 'The evaluation metrics for the find matches algorithm.
', ], ], 'FindMatchesParameters' => [ 'base' => 'The parameters to configure the find matches transform.
', 'refs' => [ 'TransformParameters$FindMatchesParameters' => 'The parameters for the find matches algorithm.
', ], ], 'FindMatchesTaskRunProperties' => [ 'base' => 'Specifies configuration properties for a Find Matches task run.
', 'refs' => [ 'TaskRunProperties$FindMatchesTaskRunProperties' => 'The configuration properties for a find matches task run.
', ], ], 'FormatString' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$InputFormat' => 'The input format: SequenceFileInputFormat
(binary), or TextInputFormat
, or a custom format.
The output format: SequenceFileOutputFormat
(binary), or IgnoreKeyTextOutputFormat
, or a custom format.
The description of the blueprint.
', 'CreateBlueprintRequest$Description' => 'A description of the blueprint.
', 'LastActiveDefinition$Description' => 'The description of the blueprint.
', 'SourceControlDetails$Repository' => 'The name of the remote repository that contains the job artifacts.
', 'SourceControlDetails$Owner' => 'The owner of the remote repository that contains the job artifacts.
', 'SourceControlDetails$Branch' => 'An optional branch in the remote repository.
', 'SourceControlDetails$Folder' => 'An optional folder in the remote repository.
', 'SourceControlDetails$LastCommitId' => 'The last commit ID for a commit in the remote repository.
', 'SourceControlDetails$AuthToken' => 'The value of an authorization token.
', 'UpdateBlueprintRequest$Description' => 'A description of the blueprint.
', ], ], 'GenericBoundedDouble' => [ 'base' => NULL, 'refs' => [ 'ColumnImportance$Importance' => 'The column importance score for the column, as a decimal.
', 'DataQualityResult$Score' => 'An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
', 'FindMatchesMetrics$AreaUnderPRCurve' => 'The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$Precision' => 'The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$Recall' => 'The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
', 'FindMatchesMetrics$F1' => 'The maximum F1 metric indicates the transform\'s accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
', 'FindMatchesParameters$PrecisionRecallTradeoff' => 'The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
', 'FindMatchesParameters$AccuracyCostTradeoff' => 'The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches
transform, sometimes with unacceptable accuracy.
Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
', 'GetDataQualityResultResponse$Score' => 'An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
', ], ], 'GenericLimitedString' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$AccessType' => 'The access type for the Redshift connection. Can be a direct connection or catalog connections.
', 'AmazonRedshiftNodeData$SourceType' => 'The source type to specify whether a specific table is the source or a custom query.
', 'AmazonRedshiftNodeData$TablePrefix' => 'Specifies the prefix to a table.
', 'AmazonRedshiftNodeData$MergeAction' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled.
', 'AmazonRedshiftNodeData$MergeWhenMatched' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
', 'AmazonRedshiftNodeData$MergeWhenNotMatched' => 'The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn\'t match a new record.
', 'DQResultsPublishingOptions$EvaluationContext' => 'The context of the evaluation.
', 'Datatype$Id' => 'The datatype of the value.
', 'Datatype$Label' => 'A label assigned to the datatype.
', 'LimitedStringList$member' => NULL, 'SnowflakeNodeData$SourceType' => 'Specifies how retrieved data is specified. Valid values: "table"
, "query"
.
Specifies a merge action. Valid values: simple
, custom
. If simple, merge behavior is defined by MergeWhenMatched
and MergeWhenNotMatched
. If custom, defined by MergeClause
.
Specifies how to resolve records that match preexisting data when merging. Valid values: update
, delete
.
Specifies how to process records that do not match preexisting data when merging. Valid values: insert
, none
.
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
', 'CreateJobRequest$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'CreateJobRequest$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'Job$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'Job$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'JobRun$Arguments' => 'The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'JobUpdate$DefaultArguments' => 'The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', 'JobUpdate$NonOverridableArguments' => 'Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
', 'StartJobRunRequest$Arguments' => 'The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
', ], ], 'GenericString' => [ 'base' => NULL, 'refs' => [ 'AdditionalPlanOptionsMap$key' => NULL, 'AdditionalPlanOptionsMap$value' => NULL, 'AmazonRedshiftAdvancedOption$Key' => 'The key for the additional connection option.
', 'AmazonRedshiftAdvancedOption$Value' => 'The value for the additional connection option.
', 'AmazonRedshiftNodeData$CatalogRedshiftSchema' => 'The Redshift schema name when working with a data catalog.
', 'AmazonRedshiftNodeData$CatalogRedshiftTable' => 'The database table to read from.
', 'AmazonRedshiftNodeData$SampleQuery' => 'The SQL used to fetch the data from a Redshift sources when the SourceType is \'query\'.
', 'AmazonRedshiftNodeData$PreAction' => 'The SQL used before a MERGE or APPEND with upsert is run.
', 'AmazonRedshiftNodeData$PostAction' => 'The SQL used before a MERGE or APPEND with upsert is run.
', 'AmazonRedshiftNodeData$Action' => 'Specifies how writing to a Redshift cluser will occur.
', 'AmazonRedshiftNodeData$MergeClause' => 'The SQL used in a custom merge to deal with matching records.
', 'AmazonRedshiftNodeData$CrawlerConnection' => 'Specifies the name of the connection that is associated with the catalog table used.
', 'AmazonRedshiftNodeData$StagingTable' => 'The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
', 'Blueprint$BlueprintLocation' => 'Specifies the path in Amazon S3 where the blueprint is published.
', 'Blueprint$BlueprintServiceLocation' => 'Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint
to register the blueprint in Glue.
The value provided for comparison on the crawl field.
', 'CreateDevEndpointRequest$EndpointName' => 'The name to be assigned to the new DevEndpoint
.
The subnet ID for the new DevEndpoint
to use.
The public key to be used by this DevEndpoint
for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint
. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.
The path to one or more Java .jar
files in an S3 bucket that should be loaded in your DevEndpoint
.
The name assigned to the new DevEndpoint
.
The current status of the new DevEndpoint
.
The subnet ID assigned to the new DevEndpoint
.
The address of the YARN endpoint used by this DevEndpoint
.
The Amazon Web Services Availability Zone where this DevEndpoint
is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint
.
The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint
.
Path to one or more Java .jar
files in an S3 bucket that will be loaded in your DevEndpoint
.
The reason for a current failure in this DevEndpoint
.
A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
This field is required when the trigger type is SCHEDULED.
', 'CreateWorkflowRequest$Description' => 'A description of the workflow.
', 'DQAdditionalOptions$value' => NULL, 'DataQualityResult$EvaluationContext' => 'In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext
can differentiate the nodes.
The name of the DevEndpoint
.
The name of the DevEndpoint
.
The subnet ID for this DevEndpoint
.
The YARN endpoint address used by this DevEndpoint
.
A private IP address to access the DevEndpoint
within a VPC if the DevEndpoint
is created within one. The PrivateAddress
field is present only when you create the DevEndpoint
within your VPC.
The public IP address used by this DevEndpoint
. The PublicAddress
field is present only when you create a non-virtual private cloud (VPC) DevEndpoint
.
The current status of this DevEndpoint
.
The Amazon Web Services Availability Zone where this DevEndpoint
is located.
The ID of the virtual private cloud (VPC) used by this DevEndpoint
.
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint
. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar
files in an S3 bucket that should be loaded in your DevEndpoint
.
You can only use pure Java/Scala libraries with a DevEndpoint
.
The reason for a current failure in this DevEndpoint
.
The status of the last update.
', 'DevEndpoint$PublicKey' => 'The public key to be used by this DevEndpoint
for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.
The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be loaded in your DevEndpoint
. Multiple values must be complete paths separated by a comma.
You can only use pure Python libraries with a DevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.
The path to one or more Java .jar
files in an S3 bucket that should be loaded in your DevEndpoint
.
You can only use pure Java/Scala libraries with a DevEndpoint
.
A continuation token, if this is a continuation request.
', 'GetBlueprintRunsResponse$NextToken' => 'A continuation token, if not all blueprint runs have been returned.
', 'GetDataQualityResultResponse$EvaluationContext' => 'In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext
can differentiate the nodes.
The error strings that are associated with the run.
', 'GetDataQualityRulesetEvaluationRunResponse$ErrorString' => 'The error strings that are associated with the run.
', 'GetDevEndpointRequest$EndpointName' => 'Name of the DevEndpoint
to retrieve information for.
A continuation token, if this is a continuation call.
', 'GetDevEndpointsResponse$NextToken' => 'A continuation token, if not all DevEndpoint
definitions have yet been returned.
A continuation token, if this is a continuation call.
', 'GetJobRunsResponse$NextToken' => 'A continuation token, if not all requested job runs have been returned.
', 'GetJobsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetJobsResponse$NextToken' => 'A continuation token, if not all job definitions have yet been returned.
', 'GetMLTaskRunResponse$LogGroupName' => 'The names of the log groups that are associated with the task run.
', 'GetMLTaskRunResponse$ErrorString' => 'The error strings that are associated with the task run.
', 'GetSecurityConfigurationsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetSecurityConfigurationsResponse$NextToken' => 'A continuation token, if there are more security configurations to return.
', 'GetTriggersRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetTriggersResponse$NextToken' => 'A continuation token, if not all the requested triggers have yet been returned.
', 'GetWorkflowRunsRequest$NextToken' => 'The maximum size of the response.
', 'GetWorkflowRunsResponse$NextToken' => 'A continuation token, if not all requested workflow runs have been returned.
', 'JobCommand$Name' => 'The name of the job command. For an Apache Spark ETL job, this must be glueetl
. For a Python shell job, it must be pythonshell
. For an Apache Spark streaming ETL job, this must be gluestreaming
. For a Ray job, this must be glueray
.
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/
, in which case the default encryption is NONE
. If you add a role name and SecurityConfiguration
name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.
Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
', 'LastActiveDefinition$BlueprintServiceLocation' => 'Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
', 'ListBlueprintsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListBlueprintsResponse$NextToken' => 'A continuation token, if not all blueprint names have been returned.
', 'ListDevEndpointsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListDevEndpointsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListJobsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListJobsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListTriggersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListTriggersResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListWorkflowsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListWorkflowsResponse$NextToken' => 'A continuation token, if not all workflow names have been returned.
', 'MapValue$key' => NULL, 'MapValue$value' => NULL, 'OrchestrationStringList$member' => NULL, 'PublicKeysList$member' => NULL, 'SnowflakeNodeData$Schema' => 'Specifies a Snowflake database schema for your node to use.
', 'SnowflakeNodeData$Table' => 'Specifies a Snowflake table for your node to use.
', 'SnowflakeNodeData$Database' => 'Specifies a Snowflake database for your node to use.
', 'SnowflakeNodeData$SampleQuery' => 'A SQL string used to retrieve data with the query
sourcetype.
A SQL string run before the Snowflake connector performs its standard actions.
', 'SnowflakeNodeData$PostAction' => 'A SQL string run after the Snowflake connector performs its standard actions.
', 'SnowflakeNodeData$Action' => 'Specifies what action to take when writing to a table with preexisting data. Valid values: append
, merge
, truncate
, drop
.
A SQL statement that specifies a custom merge behavior.
', 'SnowflakeNodeData$StagingTable' => 'The name of a staging table used when performing merge
or upsert append
actions. Data is written to this table, then moved to table
by a generated postaction.
The execution code of the statement.
', 'StatementOutput$ErrorName' => 'The name of the error in the output.
', 'StatementOutput$ErrorValue' => 'The error value of the output.
', 'StatementOutputData$TextPlain' => 'The code execution output in text format.
', 'StringList$member' => NULL, 'TaskRun$LogGroupName' => 'The names of the log group for secure logging, associated with this task run.
', 'TaskRun$ErrorString' => 'The list of error strings associated with this task run.
', 'Trigger$Schedule' => 'A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
A cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)
.
The name of the DevEndpoint
to be updated.
The public key for the DevEndpoint
to use.
The description of the workflow.
', 'Workflow$Description' => 'A description of the workflow.
', 'WorkflowRunProperties$value' => NULL, ], ], 'GetBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBlueprintRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCatalogImportStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCatalogImportStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifiersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetClassifiersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnNamesList' => [ 'base' => NULL, 'refs' => [ 'GetColumnStatisticsForPartitionRequest$ColumnNames' => 'A list of the column names.
', 'GetColumnStatisticsForTableRequest$ColumnNames' => 'A list of the column names.
', ], ], 'GetColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsTaskRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetColumnStatisticsTaskRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsFilter' => [ 'base' => 'Filters the connection definitions that are returned by the GetConnections
API operation.
A filter that controls which connections are returned.
', ], ], 'GetConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomEntityTypeResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataCatalogEncryptionSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataCatalogEncryptionSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityResultRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityResultResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataQualityRulesetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDatabasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDataflowGraphRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDataflowGraphResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobBookmarkRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobBookmarkResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTaskRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMLTransformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMappingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMappingResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionIndexesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionIndexesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPartitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRegistryInput' => [ 'base' => NULL, 'refs' => [], ], 'GetRegistryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePoliciesResponseList' => [ 'base' => NULL, 'refs' => [ 'GetResourcePoliciesResponse$GetResourcePoliciesResponseList' => 'A list of the individual resource policies and the account-level resource policy.
', ], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaByDefinitionInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaByDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionsDiffInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSchemaVersionsDiffResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSecurityConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStatementRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStatementResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableOptimizerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableOptimizerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionsList' => [ 'base' => NULL, 'refs' => [ 'GetTableVersionsResponse$TableVersions' => 'A list of strings identifying available versions of the specified table.
', ], ], 'GetTableVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTableVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTablesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTablesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionsMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredPartitionsMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredTableMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUnfilteredTableMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUsageProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUsageProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserDefinedFunctionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunPropertiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkflowRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GlueEncryptionException' => [ 'base' => 'An encryption operation failed.
', 'refs' => [], ], 'GluePolicy' => [ 'base' => 'A structure for returning a resource policy.
', 'refs' => [ 'GetResourcePoliciesResponseList$member' => NULL, ], ], 'GlueRecordType' => [ 'base' => NULL, 'refs' => [ 'JDBCDataTypeMapping$value' => NULL, ], ], 'GlueResourceArn' => [ 'base' => NULL, 'refs' => [ 'CreateRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the newly created registry.
', 'CreateSchemaResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'CreateSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'DeleteRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry being deleted.
', 'DeleteResourcePolicyRequest$ResourceArn' => 'The ARN of the Glue resource for the resource policy to be deleted.
', 'DeleteSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema being deleted.
', 'FederatedResourceAlreadyExistsException$AssociatedGlueResource' => 'The associated Glue resource already exists.
', 'GetRegistryResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'GetResourcePolicyRequest$ResourceArn' => 'The ARN of the Glue resource for which to retrieve the resource policy. If not supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies
to view all existing resource policies. For more information see Specifying Glue Resource ARNs.
The Amazon Resource Name (ARN) of the schema.
', 'GetSchemaResponse$RegistryArn' => 'The Amazon Resource Name (ARN) of the registry.
', 'GetSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'GetSchemaVersionResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'GetTagsRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
', 'PutResourcePolicyRequest$ResourceArn' => 'Do not use. For internal use only.
', 'PutSchemaVersionMetadataResponse$SchemaArn' => 'The Amazon Resource Name (ARN) for the schema.
', 'RegistryId$RegistryArn' => 'Arn of the registry to be updated. One of RegistryArn
or RegistryName
has to be provided.
The Amazon Resource Name (ARN) of the registry.
', 'RemoveSchemaVersionMetadataResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'SchemaId$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema. One of SchemaArn
or SchemaName
has to be provided.
The Amazon Resource Name (ARN) for the schema.
', 'SchemaVersionListItem$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', 'TagResourceRequest$ResourceArn' => 'The ARN of the Glue resource to which to add the tags. For more information about Glue resource ARNs, see the Glue ARN string pattern.
', 'UntagResourceRequest$ResourceArn' => 'The Amazon Resource Name (ARN) of the resource from which to remove the tags.
', 'UpdateRegistryResponse$RegistryArn' => 'The Amazon Resource name (ARN) of the updated registry.
', 'UpdateSchemaResponse$SchemaArn' => 'The Amazon Resource Name (ARN) of the schema.
', ], ], 'GlueSchema' => [ 'base' => 'Specifies a user-defined schema when a schema cannot be determined by Glue.
', 'refs' => [ 'GlueSchemas$member' => NULL, ], ], 'GlueSchemas' => [ 'base' => NULL, 'refs' => [ 'AthenaConnectorSource$OutputSchemas' => 'Specifies the data schema for the custom Athena source.
', 'CatalogDeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'CatalogHudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'ConnectorDataSource$OutputSchemas' => 'Specifies the data schema for this source.
', 'CustomCode$OutputSchemas' => 'Specifies the data schema for the custom code transform.
', 'DynamicTransform$OutputSchemas' => 'Specifies the data schema for the dynamic transform.
', 'JDBCConnectorSource$OutputSchemas' => 'Specifies the data schema for the custom JDBC source.
', 'JDBCConnectorTarget$OutputSchemas' => 'Specifies the data schema for the JDBC target.
', 'S3CatalogDeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'S3CatalogHudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'S3CsvSource$OutputSchemas' => 'Specifies the data schema for the S3 CSV source.
', 'S3DeltaSource$OutputSchemas' => 'Specifies the data schema for the Delta Lake source.
', 'S3HudiSource$OutputSchemas' => 'Specifies the data schema for the Hudi source.
', 'S3JsonSource$OutputSchemas' => 'Specifies the data schema for the S3 JSON source.
', 'S3ParquetSource$OutputSchemas' => 'Specifies the data schema for the S3 Parquet source.
', 'SnowflakeSource$OutputSchemas' => 'Specifies user-defined schemas for your output data.
', 'SparkConnectorSource$OutputSchemas' => 'Specifies data schema for the custom spark source.
', 'SparkConnectorTarget$OutputSchemas' => 'Specifies the data schema for the custom spark target.
', 'SparkSQL$OutputSchemas' => 'Specifies the data schema for the SparkSQL transform.
', ], ], 'GlueStudioColumnNameString' => [ 'base' => NULL, 'refs' => [ 'GlueStudioSchemaColumn$Name' => 'The name of the column in the Glue Studio schema.
', ], ], 'GlueStudioPathList' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Groups' => 'Specifies the fields to group by.
', 'DropFields$Paths' => 'A JSON path to a variable in the data structure.
', 'GovernedCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'JoinColumn$Keys' => 'The key of the column to be joined.
', 'Merge$PrimaryKeys' => 'The list of primary key fields to match records from the source and staging dynamic frames.
', 'S3CatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DeltaCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DeltaDirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3DirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3GlueParquetTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3HudiCatalogTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'S3HudiDirectTarget$PartitionKeys' => 'Specifies native partitioning using a sequence of keys.
', 'SelectFields$Paths' => 'A JSON path to a variable in the data structure.
', 'SplitFields$Paths' => 'A JSON path to a variable in the data structure.
', ], ], 'GlueStudioSchemaColumn' => [ 'base' => 'Specifies a single column in a Glue schema definition.
', 'refs' => [ 'GlueStudioSchemaColumnList$member' => NULL, ], ], 'GlueStudioSchemaColumnList' => [ 'base' => NULL, 'refs' => [ 'GlueSchema$Columns' => 'Specifies the column definitions that make up a Glue schema.
', ], ], 'GlueTable' => [ 'base' => 'The database and table in the Glue Data Catalog that is used for input or output data.
', 'refs' => [ 'DataSource$GlueTable' => 'An Glue table.
', 'GlueTables$member' => NULL, ], ], 'GlueTableAdditionalOptions' => [ 'base' => NULL, 'refs' => [ 'GlueTable$AdditionalOptions' => 'Additional options for the table. Currently there are two keys supported:
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset.
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
A list of Glue table definitions used by the transform.
', 'GetMLTransformResponse$InputRecordTables' => 'A list of Glue table definitions used by the transform.
', 'MLTransform$InputRecordTables' => 'A list of Glue table definitions used by the transform.
', ], ], 'GlueVersionString' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$GlueVersion' => 'Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
', 'CreateJobRequest$GlueVersion' => 'In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'CreateMLTransformRequest$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'CreateSessionRequest$GlueVersion' => 'The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
', 'DevEndpoint$GlueVersion' => 'Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'Job$GlueVersion' => 'In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'JobRun$GlueVersion' => 'In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'JobUpdate$GlueVersion' => 'In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
', 'MLTransform$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'Session$GlueVersion' => 'The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
', 'TransformFilterCriteria$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', 'UpdateMLTransformRequest$GlueVersion' => 'This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
', ], ], 'GovernedCatalogSource' => [ 'base' => 'Specifies the data store in the governed Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$GovernedCatalogSource' => 'Specifies a data source in a goverened Data Catalog.
', ], ], 'GovernedCatalogTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$GovernedCatalogTarget' => 'Specifies a data target that writes to a goverened catalog.
', ], ], 'GrokClassifier' => [ 'base' => 'A classifier that uses grok
patterns.
A classifier that uses grok
.
The grok pattern used by this classifier.
', 'GrokClassifier$GrokPattern' => 'The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.
', 'UpdateGrokClassifierRequest$GrokPattern' => 'The grok pattern used by this classifier.
', ], ], 'HashString' => [ 'base' => NULL, 'refs' => [ 'CancelDataQualityRuleRecommendationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'CancelDataQualityRulesetEvaluationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'CancelMLTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'CancelMLTaskRunRequest$TaskRunId' => 'A unique identifier for the task run.
', 'CancelMLTaskRunResponse$TransformId' => 'The unique identifier of the machine learning transform.
', 'CancelMLTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'ColumnStatisticsTaskRun$ColumnStatisticsTaskRunId' => 'The identifier for the particular column statistics task run.
', 'ColumnStatisticsTaskRunIdList$member' => NULL, 'CreateDataQualityRulesetRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'CreateMLTransformResponse$TransformId' => 'A unique identifier that is generated for the transform.
', 'DataQualityResult$ResultId' => 'A unique result ID for the data quality result.
', 'DataQualityResult$JobRunId' => 'The job run ID associated with the data quality result, if any.
', 'DataQualityResult$RulesetEvaluationRunId' => 'The unique run ID for the ruleset evaluation for this data quality result.
', 'DataQualityResultDescription$ResultId' => 'The unique result ID for this data quality result.
', 'DataQualityResultDescription$JobRunId' => 'The job run ID associated with the data quality result.
', 'DataQualityResultFilterCriteria$JobRunId' => 'Filter results by the specified job run ID.
', 'DataQualityResultIdList$member' => NULL, 'DataQualityResultIds$member' => NULL, 'DataQualityRuleRecommendationRunDescription$RunId' => 'The unique run identifier associated with this run.
', 'DataQualityRulesetEvaluationRunDescription$RunId' => 'The unique run identifier associated with this run.
', 'DataQualityRulesetListDetails$RecommendationRunId' => 'When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
', 'DeleteMLTransformRequest$TransformId' => 'The unique identifier of the transform to delete.
', 'DeleteMLTransformResponse$TransformId' => 'The unique identifier of the transform that was deleted.
', 'DeleteResourcePolicyRequest$PolicyHashCondition' => 'The hash value returned when this policy was set.
', 'FindMatchesTaskRunProperties$JobId' => 'The job ID for the Find Matches task run.
', 'FindMatchesTaskRunProperties$JobRunId' => 'The job run ID for the Find Matches task run.
', 'GetColumnStatisticsTaskRunRequest$ColumnStatisticsTaskRunId' => 'The identifier for the particular column statistics task run.
', 'GetDataQualityResultRequest$ResultId' => 'A unique result ID for the data quality result.
', 'GetDataQualityResultResponse$ResultId' => 'A unique result ID for the data quality result.
', 'GetDataQualityResultResponse$JobRunId' => 'The job run ID associated with the data quality result, if any.
', 'GetDataQualityResultResponse$RulesetEvaluationRunId' => 'The unique run ID associated with the ruleset evaluation.
', 'GetDataQualityRuleRecommendationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRuleRecommendationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetEvaluationRunRequest$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetEvaluationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'GetDataQualityRulesetResponse$RecommendationRunId' => 'When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
', 'GetMLTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'GetMLTaskRunRequest$TaskRunId' => 'The unique identifier of the task run.
', 'GetMLTaskRunResponse$TransformId' => 'The unique identifier of the task run.
', 'GetMLTaskRunResponse$TaskRunId' => 'The unique run identifier associated with this run.
', 'GetMLTaskRunsRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'GetMLTransformRequest$TransformId' => 'The unique identifier of the transform, generated at the time that the transform was created.
', 'GetMLTransformResponse$TransformId' => 'The unique identifier of the transform, generated at the time that the transform was created.
', 'GetResourcePolicyResponse$PolicyHash' => 'Contains the hash value associated with this policy.
', 'GetUnfilteredTableMetadataResponse$QueryAuthorizationId' => 'A cryptographically generated query identifier generated by Glue or Lake Formation.
', 'GluePolicy$PolicyHash' => 'Contains the hash value associated with this policy.
', 'MLTransform$TransformId' => 'The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
', 'PutResourcePolicyRequest$PolicyHashCondition' => 'The hash value returned when the previous policy was set using PutResourcePolicy
. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.
A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.
', 'QuerySessionContext$QueryId' => 'A unique identifier generated by the query engine for the query.
', 'QuerySessionContext$QueryAuthorizationId' => 'A cryptographically generated query identifier generated by Glue or Lake Formation.
', 'StartColumnStatisticsTaskRunResponse$ColumnStatisticsTaskRunId' => 'The identifier for the column statistics task run.
', 'StartDataQualityRuleRecommendationRunRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'StartDataQualityRuleRecommendationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'StartDataQualityRulesetEvaluationRunRequest$ClientToken' => 'Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
', 'StartDataQualityRulesetEvaluationRunResponse$RunId' => 'The unique run identifier associated with this run.
', 'StartExportLabelsTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartExportLabelsTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'StartImportLabelsTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartImportLabelsTaskRunResponse$TaskRunId' => 'The unique identifier for the task run.
', 'StartMLEvaluationTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartMLEvaluationTaskRunResponse$TaskRunId' => 'The unique identifier associated with this run.
', 'StartMLLabelingSetGenerationTaskRunRequest$TransformId' => 'The unique identifier of the machine learning transform.
', 'StartMLLabelingSetGenerationTaskRunResponse$TaskRunId' => 'The unique run identifier that is associated with this task run.
', 'TaskRun$TransformId' => 'The unique identifier for the transform.
', 'TaskRun$TaskRunId' => 'The unique identifier for this task run.
', 'TransformIdList$member' => NULL, 'UpdateMLTransformRequest$TransformId' => 'A unique identifier that was generated when the transform was created.
', 'UpdateMLTransformResponse$TransformId' => 'The unique identifier for the transform that was updated.
', ], ], 'HudiTarget' => [ 'base' => 'Specifies an Apache Hudi data source.
', 'refs' => [ 'HudiTargetList$member' => NULL, ], ], 'HudiTargetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3HudiDirectTarget$Compression' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Specifies Apache Hudi data store targets.
', ], ], 'IAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRest$CatalogEncryptionServiceRole' => 'The role that Glue assumes to encrypt and decrypt the Data Catalog objects on the caller\'s behalf.
', ], ], 'IcebergInput' => [ 'base' => 'A structure that defines an Apache Iceberg metadata table to create in the catalog.
', 'refs' => [ 'OpenTableFormatInput$IcebergInput' => 'Specifies an IcebergInput
structure that defines an Apache Iceberg metadata table.
Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
', 'refs' => [ 'IcebergTargetList$member' => NULL, ], ], 'IcebergTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$IcebergTargets' => 'Specifies Apache Iceberg data store targets.
', ], ], 'IdString' => [ 'base' => NULL, 'refs' => [ 'BatchStopJobRunError$JobRunId' => 'The JobRunId
of the job run in question.
The JobRunId
of the job run that was stopped.
The run ID for this blueprint.
', 'BlueprintRun$RunId' => 'The run ID for this blueprint run.
', 'GetBlueprintRunRequest$RunId' => 'The run ID for the blueprint run you want to retrieve.
', 'GetJobRunRequest$RunId' => 'The ID of the job run.
', 'GetWorkflowRunPropertiesRequest$RunId' => 'The ID of the workflow run whose run properties should be returned.
', 'GetWorkflowRunRequest$RunId' => 'The ID of the workflow run.
', 'JobRun$Id' => 'The ID of this job run.
', 'JobRun$PreviousRunId' => 'The ID of the previous run of this job. For example, the JobRunId
specified in the StartJobRun
action.
The job-run ID of the predecessor job run.
', 'PutWorkflowRunPropertiesRequest$RunId' => 'The ID of the workflow run for which the run properties should be updated.
', 'ResumeWorkflowRunRequest$RunId' => 'The ID of the workflow run to resume.
', 'ResumeWorkflowRunResponse$RunId' => 'The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
', 'StartBlueprintRunResponse$RunId' => 'The run ID for this blueprint run.
', 'StartJobRunRequest$JobRunId' => 'The ID of a previous JobRun
to retry.
The ID assigned to this job run.
', 'StartWorkflowRunResponse$RunId' => 'An Id for the new run.
', 'StopWorkflowRunRequest$RunId' => 'The ID of the workflow run to stop.
', 'Trigger$Id' => 'Reserved for future use.
', 'WorkflowRun$WorkflowRunId' => 'The ID of this workflow run.
', 'WorkflowRun$PreviousRunId' => 'The ID of the previous workflow run.
', 'WorkflowRunProperties$key' => NULL, ], ], 'IdempotentParameterMismatchException' => [ 'base' => 'The same unique identifier was associated with two different records.
', 'refs' => [], ], 'IdleTimeout' => [ 'base' => NULL, 'refs' => [ 'Session$IdleTimeout' => 'The number of minutes when idle before the session times out.
', ], ], 'IllegalBlueprintStateException' => [ 'base' => 'The blueprint is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'IllegalSessionStateException' => [ 'base' => 'The session is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'IllegalWorkflowStateException' => [ 'base' => 'The workflow is in an invalid state to perform a requested operation.
', 'refs' => [], ], 'ImportCatalogToGlueRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportCatalogToGlueResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportLabelsTaskRunProperties' => [ 'base' => 'Specifies configuration properties for an importing labels task run.
', 'refs' => [ 'TaskRunProperties$ImportLabelsTaskRunProperties' => 'The configuration properties for an importing labels task run.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'CodeGenNode$LineNumber' => 'The line number of the node.
', 'DecimalNumber$Scale' => 'The scale that determines where the decimal point falls in the unscaled value.
', 'StorageDescriptor$NumberOfBuckets' => 'Must be specified if the table contains any dimension columns.
', ], ], 'IntegerFlag' => [ 'base' => NULL, 'refs' => [ 'Order$SortOrder' => 'Indicates that the column is sorted in ascending order (== 1
), or in descending order (==0
).
The ID of the statement to be cancelled.
', 'CreateDevEndpointRequest$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) to allocate to this DevEndpoint
.
The Apache Zeppelin port for the remote Apache Spark interpreter.
', 'CreateDevEndpointResponse$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
', 'CreateJobRequest$AllocatedCapacity' => 'This parameter is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'DevEndpoint$ZeppelinRemoteSparkInterpreterPort' => 'The Apache Zeppelin port for the remote Apache Spark interpreter.
', 'DevEndpoint$NumberOfNodes' => 'The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint
.
The Id of the statement.
', 'Job$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'JobBookmarkEntry$Version' => 'The version of the job.
', 'JobBookmarkEntry$Run' => 'The run ID number.
', 'JobBookmarkEntry$Attempt' => 'The attempt ID number.
', 'JobRun$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'JobUpdate$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'RunStatementResponse$Id' => 'Returns the Id of the statement that was run.
', 'StartJobRunRequest$AllocatedCapacity' => 'This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
', 'Statement$Id' => 'The ID of the statement.
', 'StatementOutput$ExecutionCount' => 'The execution count of the output.
', 'WorkflowRunStatistics$TotalActions' => 'Total number of Actions in the workflow run.
', 'WorkflowRunStatistics$TimeoutActions' => 'Total number of Actions that timed out.
', 'WorkflowRunStatistics$FailedActions' => 'Total number of Actions that have failed.
', 'WorkflowRunStatistics$StoppedActions' => 'Total number of Actions that have stopped.
', 'WorkflowRunStatistics$SucceededActions' => 'Total number of Actions that have succeeded.
', 'WorkflowRunStatistics$RunningActions' => 'Total number Actions in running state.
', 'WorkflowRunStatistics$ErroredActions' => 'Indicates the count of job runs in the ERROR state in the workflow run.
', 'WorkflowRunStatistics$WaitingActions' => 'Indicates the count of job runs in WAITING state in the workflow run.
', ], ], 'InternalServiceException' => [ 'base' => 'An internal service error occurred.
', 'refs' => [], ], 'InvalidInputException' => [ 'base' => 'The input provided was not valid.
', 'refs' => [], ], 'InvalidStateException' => [ 'base' => 'An error that indicates your data is in an invalid state.
', 'refs' => [], ], 'IsVersionValid' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityResponse$Valid' => 'Return true, if the schema is valid and false otherwise.
', ], ], 'Iso8601DateTime' => [ 'base' => NULL, 'refs' => [ 'KafkaStreamingSourceOptions$StartingTimestamp' => 'The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
Only one of StartingTimestamp
or StartingOffsets
must be set.
The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
The connection type of the JDBC source.
', ], ], 'JDBCConnectorOptions' => [ 'base' => 'Additional connection options for the connector.
', 'refs' => [ 'JDBCConnectorSource$AdditionalOptions' => 'Additional connection options for the connector.
', ], ], 'JDBCConnectorSource' => [ 'base' => 'Specifies a connector to a JDBC data source.
', 'refs' => [ 'CodeGenConfigurationNode$JDBCConnectorSource' => 'Specifies a connector to a JDBC data source.
', ], ], 'JDBCConnectorTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', 'refs' => [ 'CodeGenConfigurationNode$JDBCConnectorTarget' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', ], ], 'JDBCDataType' => [ 'base' => NULL, 'refs' => [ 'JDBCDataTypeMapping$key' => NULL, ], ], 'JDBCDataTypeMapping' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorOptions$DataTypeMapping' => 'Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option "dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC type FLOAT
into the Java String
type by calling the ResultSet.getString()
method of the driver, and uses it to build the Glue record. The ResultSet
object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
Specifies a JDBC data store to crawl.
', 'refs' => [ 'JdbcTargetList$member' => NULL, ], ], 'JdbcTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$JdbcTargets' => 'Specifies JDBC targets.
', ], ], 'Job' => [ 'base' => 'Specifies a job definition.
', 'refs' => [ 'GetJobResponse$Job' => 'The requested job definition.
', 'JobList$member' => NULL, ], ], 'JobBookmarkEntry' => [ 'base' => 'Defines a point that a job can resume processing.
', 'refs' => [ 'GetJobBookmarkResponse$JobBookmarkEntry' => 'A structure that defines a point that a job can resume processing.
', 'ResetJobBookmarkResponse$JobBookmarkEntry' => 'The reset bookmark entry.
', ], ], 'JobBookmarksEncryption' => [ 'base' => 'Specifies how job bookmark data should be encrypted.
', 'refs' => [ 'EncryptionConfiguration$JobBookmarksEncryption' => 'The encryption configuration for job bookmarks.
', ], ], 'JobBookmarksEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'JobBookmarksEncryption$JobBookmarksEncryptionMode' => 'The encryption mode to use for job bookmarks data.
', ], ], 'JobCommand' => [ 'base' => 'Specifies code that runs when a job is run.
', 'refs' => [ 'CreateJobRequest$Command' => 'The JobCommand
that runs this job.
The JobCommand
that runs this job.
The JobCommand
that runs this job (required).
A list of job definitions.
', 'GetJobsResponse$Jobs' => 'A list of job definitions.
', ], ], 'JobMode' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$JobMode' => 'A mode that describes how a job was created. Valid values are:
SCRIPT
- The job was created using the Glue Studio script editor.
VISUAL
- The job was created using the Glue Studio visual editor.
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
A mode that describes how a job was created. Valid values are:
SCRIPT
- The job was created using the Glue Studio script editor.
VISUAL
- The job was created using the Glue Studio visual editor.
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
A mode that describes how a job was created. Valid values are:
SCRIPT
- The job was created using the Glue Studio script editor.
VISUAL
- The job was created using the Glue Studio visual editor.
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
A mode that describes how a job was created. Valid values are:
SCRIPT
- The job was created using the Glue Studio script editor.
VISUAL
- The job was created using the Glue Studio visual editor.
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
The name of the job in question.
', 'JobBookmarkEntry$JobName' => 'The name of the job in question.
', 'ResetJobBookmarkRequest$JobName' => 'The name of the job in question.
', ], ], 'JobNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetJobsRequest$JobNames' => 'A list of job names, which might be the names returned from the ListJobs
operation.
A list of names of jobs not found.
', 'ListJobsResponse$JobNames' => 'The names of all jobs in the account, or the jobs with the specified tags.
', ], ], 'JobNodeDetails' => [ 'base' => 'The details of a Job node present in the workflow.
', 'refs' => [ 'Node$JobDetails' => 'Details of the Job when the node represents a Job.
', ], ], 'JobRun' => [ 'base' => 'Contains information about a job run.
', 'refs' => [ 'GetJobRunResponse$JobRun' => 'The requested job-run metadata.
', 'JobRunList$member' => NULL, ], ], 'JobRunList' => [ 'base' => NULL, 'refs' => [ 'GetJobRunsResponse$JobRuns' => 'A list of job-run metadata objects.
', 'JobNodeDetails$JobRuns' => 'The information for the job runs represented by the job node.
', ], ], 'JobRunState' => [ 'base' => NULL, 'refs' => [ 'Condition$State' => 'The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED
, STOPPED
, FAILED
, and TIMEOUT
. The only crawler states that a trigger can listen for are SUCCEEDED
, FAILED
, and CANCELLED
.
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
', ], ], 'JobUpdate' => [ 'base' => 'Specifies information used to update an existing job definition. The previous job definition is completely overwritten by this information.
', 'refs' => [ 'UpdateJobRequest$JobUpdate' => 'Specifies the values with which to update the job definition. Unspecified configuration is removed or reset to default values.
', ], ], 'Join' => [ 'base' => 'Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
', 'refs' => [ 'CodeGenConfigurationNode$Join' => 'Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
', ], ], 'JoinColumn' => [ 'base' => 'Specifies a column to be joined.
', 'refs' => [ 'JoinColumns$member' => NULL, ], ], 'JoinColumns' => [ 'base' => NULL, 'refs' => [ 'Join$Columns' => 'A list of the two columns to be joined.
', ], ], 'JoinType' => [ 'base' => NULL, 'refs' => [ 'Join$JoinType' => 'Specifies the type of join to be performed on the datasets.
', ], ], 'JsonClassifier' => [ 'base' => 'A classifier for JSON
content.
A classifier for JSON content.
', ], ], 'JsonPath' => [ 'base' => NULL, 'refs' => [ 'CreateJsonClassifierRequest$JsonPath' => 'A JsonPath
string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
A JsonPath
string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
A JsonPath
string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
The bookmark itself.
', ], ], 'KafkaStreamingSourceOptions' => [ 'base' => 'Additional options for streaming.
', 'refs' => [ 'CatalogKafkaSource$StreamingOptions' => 'Specifies the streaming options.
', 'DirectKafkaSource$StreamingOptions' => 'Specifies the streaming options.
', ], ], 'KeyList' => [ 'base' => NULL, 'refs' => [ 'PartitionIndex$Keys' => 'The keys for the partition index.
', ], ], 'KeySchemaElement' => [ 'base' => 'A partition key pair consisting of a name and a type.
', 'refs' => [ 'KeySchemaElementList$member' => NULL, ], ], 'KeySchemaElementList' => [ 'base' => NULL, 'refs' => [ 'PartitionIndexDescriptor$Keys' => 'A list of one or more keys, as KeySchemaElement
structures, for the partition index.
Additional options for the Amazon Kinesis streaming data source.
', 'refs' => [ 'CatalogKinesisSource$StreamingOptions' => 'Additional options for the Kinesis streaming data source.
', 'DirectKinesisSource$StreamingOptions' => 'Additional options for the Kinesis streaming data source.
', ], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'CloudWatchEncryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', 'JobBookmarksEncryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', 'S3Encryption$KmsKeyArn' => 'The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
', ], ], 'LabelCount' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformResponse$LabelCount' => 'The number of labels available for this transform.
', 'MLTransform$LabelCount' => 'A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
', ], ], 'LabelingSetGenerationTaskRunProperties' => [ 'base' => 'Specifies configuration properties for a labeling set generation task run.
', 'refs' => [ 'TaskRunProperties$LabelingSetGenerationTaskRunProperties' => 'The configuration properties for a labeling set generation task run.
', ], ], 'LakeFormationConfiguration' => [ 'base' => 'Specifies Lake Formation configuration settings for the crawler.
', 'refs' => [ 'Crawler$LakeFormationConfiguration' => 'Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
', 'CreateCrawlerRequest$LakeFormationConfiguration' => 'Specifies Lake Formation configuration settings for the crawler.
', 'UpdateCrawlerRequest$LakeFormationConfiguration' => 'Specifies Lake Formation configuration settings for the crawler.
', ], ], 'Language' => [ 'base' => NULL, 'refs' => [ 'CreateScriptRequest$Language' => 'The programming language of the resulting code from the DAG.
', 'GetPlanRequest$Language' => 'The programming language of the code to perform the mapping.
', ], ], 'LastActiveDefinition' => [ 'base' => 'When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
', 'refs' => [ 'Blueprint$LastActiveDefinition' => 'When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
', ], ], 'LastCrawlInfo' => [ 'base' => 'Status and error information about the most recent crawl.
', 'refs' => [ 'Crawler$LastCrawl' => 'The status of the last crawl, and potentially error information if an error occurred.
', ], ], 'LastCrawlStatus' => [ 'base' => NULL, 'refs' => [ 'LastCrawlInfo$Status' => 'Status of the last crawl.
', ], ], 'LatestSchemaVersionBoolean' => [ 'base' => NULL, 'refs' => [ 'PutSchemaVersionMetadataResponse$LatestVersion' => 'The latest version of the schema.
', 'RemoveSchemaVersionMetadataResponse$LatestVersion' => 'The latest version of the schema.
', 'SchemaVersionNumber$LatestVersion' => 'The latest version available for the schema.
', ], ], 'LimitedPathList' => [ 'base' => NULL, 'refs' => [ 'DropDuplicates$Columns' => 'The name of the columns to be merged or removed if repeating.
', ], ], 'LimitedStringList' => [ 'base' => NULL, 'refs' => [ 'LimitedPathList$member' => NULL, ], ], 'LineageConfiguration' => [ 'base' => 'Specifies data lineage configuration settings for the crawler.
', 'refs' => [ 'Crawler$LineageConfiguration' => 'A configuration that specifies whether data lineage is enabled for the crawler.
', 'CreateCrawlerRequest$LineageConfiguration' => 'Specifies data lineage configuration settings for the crawler.
', 'UpdateCrawlerRequest$LineageConfiguration' => 'Specifies data lineage configuration settings for the crawler.
', ], ], 'ListBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListColumnStatisticsTaskRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListColumnStatisticsTaskRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCrawlsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomEntityTypesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityResultsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityResultsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRuleRecommendationRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRuleRecommendationRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetEvaluationRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetEvaluationRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDataQualityRulesetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDevEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDevEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMLTransformsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMLTransformsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistriesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListRegistriesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemasResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSessionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSessionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStatementsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStatementsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTableOptimizerRunsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTableOptimizerRunsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTableOptimizerRunsToken' => [ 'base' => NULL, 'refs' => [ 'ListTableOptimizerRunsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListTableOptimizerRunsResponse$NextToken' => 'A continuation token for paginating the returned list of optimizer runs, returned if the current segment of the list is not the last.
', ], ], 'ListTriggersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTriggersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsageProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsageProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkflowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => 'The location of resources.
', 'refs' => [ 'GetMappingRequest$Location' => 'Parameters for the mapping.
', 'GetPlanRequest$Location' => 'The parameters for the mapping.
', ], ], 'LocationMap' => [ 'base' => NULL, 'refs' => [ 'SkewedInfo$SkewedColumnValueLocationMaps' => 'A mapping of skewed values to the columns that contain them.
', ], ], 'LocationString' => [ 'base' => NULL, 'refs' => [ 'LocationStringList$member' => NULL, 'StorageDescriptor$Location' => 'The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.
', ], ], 'LocationStringList' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$AdditionalLocations' => 'A list of locations that point to the path where a Delta table is located.
', ], ], 'LogGroup' => [ 'base' => NULL, 'refs' => [ 'Crawl$LogGroup' => 'The log group associated with the crawl.
', 'CrawlerHistory$LogGroup' => 'The log group associated with the crawl.
', 'LastCrawlInfo$LogGroup' => 'The log group for the last crawl.
', ], ], 'LogStream' => [ 'base' => NULL, 'refs' => [ 'Crawl$LogStream' => 'The log stream associated with the crawl.
', 'CrawlerHistory$LogStream' => 'The log stream associated with the crawl.
', 'LastCrawlInfo$LogStream' => 'The log stream for the last crawl.
', ], ], 'Logical' => [ 'base' => NULL, 'refs' => [ 'Predicate$Logical' => 'An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.
', ], ], 'LogicalOperator' => [ 'base' => NULL, 'refs' => [ 'Condition$LogicalOperator' => 'A logical operator.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'LongColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'LongColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', ], ], 'LongColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for integer data columns.
', 'refs' => [ 'ColumnStatisticsData$LongColumnStatisticsData' => 'Long column statistics data.
', ], ], 'LongValue' => [ 'base' => NULL, 'refs' => [ 'Statement$StartedOn' => 'The unix time and date that the job definition was started.
', 'Statement$CompletedOn' => 'The unix time and date that the job definition was completed.
', ], ], 'LongValueString' => [ 'base' => NULL, 'refs' => [ 'Connection$StatusReason' => 'The reason for the connection status.
', ], ], 'MLTransform' => [ 'base' => 'A structure for a machine learning transform.
', 'refs' => [ 'TransformList$member' => NULL, ], ], 'MLTransformNotReadyException' => [ 'base' => 'The machine learning transform is not ready to run.
', 'refs' => [], ], 'MLUserDataEncryption' => [ 'base' => 'The encryption-at-rest settings of the transform that apply to accessing user data.
', 'refs' => [ 'TransformEncryption$MlUserDataEncryption' => 'An MLUserDataEncryption
object containing the encryption mode and customer-provided KMS key ID.
The encryption mode applied to user data. Valid values are:
DISABLED: encryption is disabled
SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
', 'Job$MaintenanceWindow' => 'This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
', 'JobRun$MaintenanceWindow' => 'This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
', 'JobUpdate$MaintenanceWindow' => 'This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
', ], ], 'ManyInputs' => [ 'base' => NULL, 'refs' => [ 'CustomCode$Inputs' => 'The data inputs identified by their node names.
', 'EvaluateDataQualityMultiFrame$Inputs' => 'The inputs of your data quality evaluation. The first input in this list is the primary data source.
', 'SparkSQL$Inputs' => 'The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
', ], ], 'MapValue' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$Arguments' => 'A map of arguments used to configure the DevEndpoint
.
The map of arguments used to configure this DevEndpoint
.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
A map of arguments used to configure the DevEndpoint
.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
The map of arguments to add the map of arguments used to configure the DevEndpoint
.
Valid arguments are:
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the Arguments
parameter in the CreateDevEndpoint
or UpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.
Specifies the mapping of data property keys.
', 'refs' => [ 'Mappings$member' => NULL, ], ], 'MappingEntry' => [ 'base' => 'Defines a mapping.
', 'refs' => [ 'MappingList$member' => NULL, ], ], 'MappingList' => [ 'base' => NULL, 'refs' => [ 'GetMappingResponse$Mapping' => 'A list of mappings to the specified targets.
', 'GetPlanRequest$Mapping' => 'The list of mappings from a source table to target tables.
', ], ], 'Mappings' => [ 'base' => NULL, 'refs' => [ 'ApplyMapping$Mapping' => 'Specifies the mapping of data property keys in the data source to data property keys in the data target.
', 'Mapping$Children' => 'Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping
, but its FromPath
will be the parent\'s FromPath
plus the FromPath
from this structure.
For the children part, suppose you have the structure:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
You can specify a Mapping
that looks like:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
Indicates the value that will replace the detected entity.
', ], ], 'MatchCriteria' => [ 'base' => NULL, 'refs' => [ 'Connection$MatchCriteria' => 'A list of criteria that can be used in selecting this connection.
', 'ConnectionInput$MatchCriteria' => 'A list of criteria that can be used in selecting this connection.
', 'GetConnectionsFilter$MatchCriteria' => 'A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
', ], ], 'MaxConcurrentRuns' => [ 'base' => NULL, 'refs' => [ 'ExecutionProperty$MaxConcurrentRuns' => 'The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
', ], ], 'MaxListTableOptimizerRunsTokenResults' => [ 'base' => NULL, 'refs' => [ 'ListTableOptimizerRunsRequest$MaxResults' => 'The maximum number of optimizer runs to return on each call.
', ], ], 'MaxResultsNumber' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', 'ListSchemaVersionsInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', 'ListSchemasInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', ], ], 'MaxRetries' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$MaxRetries' => 'The maximum number of times to retry this job if it fails.
', 'Job$MaxRetries' => 'The maximum number of times to retry this job after a JobRun fails.
', 'JobUpdate$MaxRetries' => 'The maximum number of times to retry this job if it fails.
', ], ], 'Merge' => [ 'base' => 'Specifies a transform that merges a DynamicFrame
with a staging DynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
Specifies a transform that merges a DynamicFrame
with a staging DynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
The prefix for a CloudWatch message about this crawl.
', 'LastCrawlInfo$MessagePrefix' => 'The prefix for a message about this crawl.
', ], ], 'MessageString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => 'A message describing the problem.
', 'AlreadyExistsException$Message' => 'A message describing the problem.
', 'BlueprintRun$ErrorMessage' => 'Indicates any errors that are seen while running the blueprint.
', 'BlueprintRun$RollbackErrorMessage' => 'If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
', 'ColumnStatisticsTaskNotRunningException$Message' => 'A message describing the problem.
', 'ColumnStatisticsTaskRunningException$Message' => 'A message describing the problem.
', 'ColumnStatisticsTaskStoppingException$Message' => 'A message describing the problem.
', 'ConcurrentModificationException$Message' => 'A message describing the problem.
', 'ConcurrentRunsExceededException$Message' => 'A message describing the problem.
', 'ConditionCheckFailureException$Message' => 'A message describing the problem.
', 'ConflictException$Message' => 'A message describing the problem.
', 'CrawlerNotRunningException$Message' => 'A message describing the problem.
', 'CrawlerRunningException$Message' => 'A message describing the problem.
', 'CrawlerStoppingException$Message' => 'A message describing the problem.
', 'EntityNotFoundException$Message' => 'A message describing the problem.
', 'FederatedResourceAlreadyExistsException$Message' => 'The message describing the problem.
', 'FederationSourceException$Message' => 'The message describing the problem.
', 'FederationSourceRetryableException$Message' => 'A message describing the problem.
', 'GlueEncryptionException$Message' => 'The message describing the problem.
', 'IdempotentParameterMismatchException$Message' => 'A message describing the problem.
', 'IllegalBlueprintStateException$Message' => 'A message describing the problem.
', 'IllegalSessionStateException$Message' => 'A message describing the problem.
', 'IllegalWorkflowStateException$Message' => 'A message describing the problem.
', 'InternalServiceException$Message' => 'A message describing the problem.
', 'InvalidInputException$Message' => 'A message describing the problem.
', 'InvalidStateException$Message' => 'A message describing the problem.
', 'MLTransformNotReadyException$Message' => 'A message describing the problem.
', 'NoScheduleException$Message' => 'A message describing the problem.
', 'OperationNotSupportedException$Message' => 'A message describing the problem.
', 'OperationTimeoutException$Message' => 'A message describing the problem.
', 'PermissionTypeMismatchException$Message' => 'There is a mismatch between the SupportedPermissionType used in the query request and the permissions defined on the target table.
', 'ResourceNotReadyException$Message' => 'A message describing the problem.
', 'ResourceNumberLimitExceededException$Message' => 'A message describing the problem.
', 'RunMetrics$NumberOfBytesCompacted' => 'The number of bytes removed by the compaction job run.
', 'RunMetrics$NumberOfFilesCompacted' => 'The number of files removed by the compaction job run.
', 'RunMetrics$NumberOfDpus' => 'The number of DPU hours consumed by the job.
', 'RunMetrics$JobDurationInHour' => 'The duration of the job in hours.
', 'SchedulerNotRunningException$Message' => 'A message describing the problem.
', 'SchedulerRunningException$Message' => 'A message describing the problem.
', 'SchedulerTransitioningException$Message' => 'A message describing the problem.
', 'TableOptimizerRun$error' => 'An error that occured during the optimizer run.
', 'ValidationException$Message' => 'A message describing the problem.
', 'VersionMismatchException$Message' => 'A message describing the problem.
', ], ], 'MetadataInfo' => [ 'base' => 'A structure containing metadata information for a schema version.
', 'refs' => [ 'MetadataInfoMap$value' => NULL, ], ], 'MetadataInfoMap' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataResponse$MetadataInfoMap' => 'A map of a metadata key and associated values.
', ], ], 'MetadataKeyString' => [ 'base' => NULL, 'refs' => [ 'MetadataInfoMap$key' => NULL, 'MetadataKeyValuePair$MetadataKey' => 'A metadata key.
', 'PutSchemaVersionMetadataResponse$MetadataKey' => 'The metadata key.
', 'RemoveSchemaVersionMetadataResponse$MetadataKey' => 'The metadata key.
', ], ], 'MetadataKeyValuePair' => [ 'base' => 'A structure containing a key value pair for metadata.
', 'refs' => [ 'MetadataList$member' => NULL, 'PutSchemaVersionMetadataInput$MetadataKeyValue' => 'The metadata key\'s corresponding value.
', 'RemoveSchemaVersionMetadataInput$MetadataKeyValue' => 'The value of the metadata key.
', ], ], 'MetadataList' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataInput$MetadataList' => 'Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
', ], ], 'MetadataOperation' => [ 'base' => NULL, 'refs' => [ 'IcebergInput$MetadataOperation' => 'A required metadata operation. Can only be set to CREATE
.
The metadata key’s corresponding value.
', 'MetadataKeyValuePair$MetadataValue' => 'A metadata key’s corresponding value.
', 'OtherMetadataValueListItem$MetadataValue' => 'The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
', 'PutSchemaVersionMetadataResponse$MetadataValue' => 'The value of the metadata key.
', 'RemoveSchemaVersionMetadataResponse$MetadataValue' => 'The value of the metadata key.
', ], ], 'MetricBasedObservation' => [ 'base' => 'Describes the metric based observation generated based on evaluated data quality metrics.
', 'refs' => [ 'DataQualityObservation$MetricBasedObservation' => 'An object of type MetricBasedObservation
representing the observation that is based on evaluated data quality metrics.
Specifies a Microsoft SQL server data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$MicrosoftSQLServerCatalogSource' => 'Specifies a Microsoft SQL server data source in the Glue Data Catalog.
', ], ], 'MicrosoftSQLServerCatalogTarget' => [ 'base' => 'Specifies a target that uses Microsoft SQL.
', 'refs' => [ 'CodeGenConfigurationNode$MicrosoftSQLServerCatalogTarget' => 'Specifies a target that uses Microsoft SQL.
', ], ], 'MillisecondsCount' => [ 'base' => NULL, 'refs' => [ 'Crawler$CrawlElapsedTime' => 'If the crawler is running, contains the total time elapsed since the last crawl began.
', ], ], 'MongoDBTarget' => [ 'base' => 'Specifies an Amazon DocumentDB or MongoDB data store to crawl.
', 'refs' => [ 'MongoDBTargetList$member' => NULL, ], ], 'MongoDBTargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$MongoDBTargets' => 'Specifies Amazon DocumentDB or MongoDB targets.
', ], ], 'MySQLCatalogSource' => [ 'base' => 'Specifies a MySQL data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$MySQLCatalogSource' => 'Specifies a MySQL data source in the Glue Data Catalog.
', ], ], 'MySQLCatalogTarget' => [ 'base' => 'Specifies a target that uses MySQL.
', 'refs' => [ 'CodeGenConfigurationNode$MySQLCatalogTarget' => 'Specifies a target that uses MySQL.
', ], ], 'NameString' => [ 'base' => NULL, 'refs' => [ 'Action$JobName' => 'The name of a job to be run.
', 'Action$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this action.
The name of the crawler to be used with this action.
', 'BatchCreatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be created.
', 'BatchCreatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be created.
', 'BatchDeletePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'BatchDeletePartitionRequest$TableName' => 'The name of the table that contains the partitions to be deleted.
', 'BatchDeleteTableNameList$member' => NULL, 'BatchDeleteTableRequest$DatabaseName' => 'The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.
', 'BatchDeleteTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'BatchDeleteTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'BatchGetPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'BatchGetPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'BatchStopJobRunError$JobName' => 'The name of the job definition that is used in the job run in question.
', 'BatchStopJobRunRequest$JobName' => 'The name of the job definition for which to stop job runs.
', 'BatchStopJobRunSuccessfulSubmission$JobName' => 'The name of the job definition used in the job run that was stopped.
', 'BatchUpdatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be updated.
', 'BatchUpdatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be updated.
', 'BlueprintRun$WorkflowName' => 'The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
', 'CancelStatementRequest$SessionId' => 'The Session ID of the statement to be cancelled.
', 'CatalogEntry$DatabaseName' => 'The database in which the table metadata resides.
', 'CatalogEntry$TableName' => 'The name of the table in question.
', 'CatalogImportStatus$ImportedBy' => 'The name of the person who initiated the migration.
', 'CatalogTablesList$member' => NULL, 'CatalogTarget$DatabaseName' => 'The name of the database to be synchronized.
', 'ClassifierNameList$member' => NULL, 'Column$Name' => 'The name of the Column
.
The name of the column that failed.
', 'ColumnImportance$ColumnName' => 'The name of a column.
', 'ColumnNameList$member' => NULL, 'ColumnRowFilter$ColumnName' => 'A string containing the name of the column.
', 'ColumnStatistics$ColumnName' => 'Name of column which statistics belong to.
', 'ColumnStatisticsTaskRun$WorkerType' => 'The type of workers being used for generating stats. The default is g.1x
.
The name of the job whose JobRuns
this condition applies to, and on which this trigger waits.
The name of the crawler to which this condition applies.
', 'ConfigurationMap$key' => NULL, 'Connection$Name' => 'The name of the connection definition.
', 'Connection$LastUpdatedBy' => 'The user, group, or role that last updated this connection definition.
', 'ConnectionInput$Name' => 'The name of the connection.
', 'ConnectionPasswordEncryption$AwsKmsKeyId' => 'An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of CreateConnection
and UpdateConnection
needs at least kms:Encrypt
permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
', 'ContextWords$member' => NULL, 'Crawler$Name' => 'The name of the crawler.
', 'CrawlerHistory$Summary' => 'A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.
', 'CrawlerMetrics$CrawlerName' => 'The name of the crawler.
', 'CrawlerNameList$member' => NULL, 'CreateBlueprintResponse$Name' => 'Returns the name of the blueprint that was registered.
', 'CreateCrawlerRequest$Name' => 'Name of the new crawler.
', 'CreateCsvClassifierRequest$Name' => 'The name of the classifier.
', 'CreateCustomEntityTypeRequest$Name' => 'A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
', 'CreateCustomEntityTypeRequest$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'CreateCustomEntityTypeResponse$Name' => 'The name of the custom pattern you created.
', 'CreateDataQualityRulesetRequest$Name' => 'A unique name for the data quality ruleset.
', 'CreateDataQualityRulesetResponse$Name' => 'A unique name for the data quality ruleset.
', 'CreateDevEndpointRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this DevEndpoint
.
The name of the SecurityConfiguration
structure being used with this DevEndpoint
.
The name of the new classifier.
', 'CreateJobRequest$Name' => 'The name you assign to this job definition. It must be unique in your account.
', 'CreateJobRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job.
The unique name that was provided for this job definition.
', 'CreateJsonClassifierRequest$Name' => 'The name of the classifier.
', 'CreateMLTransformRequest$Name' => 'The unique name that you give the transform when you create it.
', 'CreatePartitionIndexRequest$DatabaseName' => 'Specifies the name of a database in which you want to create a partition index.
', 'CreatePartitionIndexRequest$TableName' => 'Specifies the name of a table in which you want to create a partition index.
', 'CreatePartitionRequest$DatabaseName' => 'The name of the metadata database in which the partition is to be created.
', 'CreatePartitionRequest$TableName' => 'The name of the metadata table in which the partition is to be created.
', 'CreateSecurityConfigurationRequest$Name' => 'The name for the new security configuration.
', 'CreateSecurityConfigurationResponse$Name' => 'The name assigned to the new security configuration.
', 'CreateSessionRequest$Id' => 'The ID of the session request.
', 'CreateSessionRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with the session
', 'CreateTableOptimizerRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'CreateTableOptimizerRequest$TableName' => 'The name of the table.
', 'CreateTableRequest$DatabaseName' => 'The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
', 'CreateTriggerRequest$Name' => 'The name of the trigger.
', 'CreateTriggerRequest$WorkflowName' => 'The name of the workflow associated with the trigger.
', 'CreateTriggerResponse$Name' => 'The name of the trigger.
', 'CreateUsageProfileRequest$Name' => 'The name of the usage profile.
', 'CreateUsageProfileResponse$Name' => 'The name of the usage profile that was created.
', 'CreateUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database in which to create the function.
', 'CreateWorkflowRequest$Name' => 'The name to be assigned to the workflow. It should be unique within your account.
', 'CreateWorkflowResponse$Name' => 'The name of the workflow which was provided as part of the request.
', 'CreateXMLClassifierRequest$Name' => 'The name of the classifier.
', 'CsvClassifier$Name' => 'The name of the classifier.
', 'CsvHeader$member' => NULL, 'CustomDatatypes$member' => NULL, 'CustomEntityType$Name' => 'A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
', 'CustomEntityType$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'CustomEntityTypeNames$member' => NULL, 'DataQualityAnalyzerResult$Name' => 'The name of the data quality analyzer.
', 'DataQualityResult$RulesetName' => 'The name of the ruleset associated with the data quality result.
', 'DataQualityResult$JobName' => 'The job name associated with the data quality result, if any.
', 'DataQualityResultDescription$JobName' => 'The job name associated with the data quality result.
', 'DataQualityResultFilterCriteria$JobName' => 'Filter results by the specified job name.
', 'DataQualityRuleResult$Name' => 'The name of the data quality rule.
', 'DataQualityRulesetFilterCriteria$Name' => 'The name of the ruleset filter criteria.
', 'DataQualityRulesetListDetails$Name' => 'The name of the data quality ruleset.
', 'DataQualityTargetTable$TableName' => 'The name of the Glue table.
', 'DataQualityTargetTable$DatabaseName' => 'The name of the database where the Glue table exists.
', 'DataQualityTargetTable$CatalogId' => 'The catalog id where the Glue table exists.
', 'DataSourceMap$key' => NULL, 'Database$Name' => 'The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
', 'DatabaseIdentifier$DatabaseName' => 'The name of the catalog database.
', 'DatabaseIdentifier$Region' => 'Region of the target database.
', 'DatabaseInput$Name' => 'The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
', 'DeleteBlueprintRequest$Name' => 'The name of the blueprint to delete.
', 'DeleteBlueprintResponse$Name' => 'Returns the name of the blueprint that was deleted.
', 'DeleteClassifierRequest$Name' => 'Name of the classifier to remove.
', 'DeleteColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'DeleteColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'DeleteColumnStatisticsForPartitionRequest$ColumnName' => 'Name of the column.
', 'DeleteColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'DeleteColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'DeleteColumnStatisticsForTableRequest$ColumnName' => 'The name of the column.
', 'DeleteConnectionNameList$member' => NULL, 'DeleteConnectionRequest$ConnectionName' => 'The name of the connection to delete.
', 'DeleteCrawlerRequest$Name' => 'The name of the crawler to remove.
', 'DeleteCustomEntityTypeRequest$Name' => 'The name of the custom pattern that you want to delete.
', 'DeleteCustomEntityTypeResponse$Name' => 'The name of the custom pattern you deleted.
', 'DeleteDataQualityRulesetRequest$Name' => 'A name for the data quality ruleset.
', 'DeleteDatabaseRequest$Name' => 'The name of the database to delete. For Hive compatibility, this must be all lowercase.
', 'DeleteJobRequest$JobName' => 'The name of the job definition to delete.
', 'DeleteJobResponse$JobName' => 'The name of the job definition that was deleted.
', 'DeletePartitionIndexRequest$DatabaseName' => 'Specifies the name of a database from which you want to delete a partition index.
', 'DeletePartitionIndexRequest$TableName' => 'Specifies the name of a table from which you want to delete a partition index.
', 'DeletePartitionIndexRequest$IndexName' => 'The name of the partition index to be deleted.
', 'DeletePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'DeletePartitionRequest$TableName' => 'The name of the table that contains the partition to be deleted.
', 'DeleteSecurityConfigurationRequest$Name' => 'The name of the security configuration to delete.
', 'DeleteSessionRequest$Id' => 'The ID of the session to be deleted.
', 'DeleteSessionResponse$Id' => 'Returns the ID of the deleted session.
', 'DeleteTableOptimizerRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'DeleteTableOptimizerRequest$TableName' => 'The name of the table.
', 'DeleteTableRequest$DatabaseName' => 'The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableRequest$Name' => 'The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'DeleteTriggerRequest$Name' => 'The name of the trigger to delete.
', 'DeleteTriggerResponse$Name' => 'The name of the trigger that was deleted.
', 'DeleteUsageProfileRequest$Name' => 'The name of the usage profile to delete.
', 'DeleteUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function is located.
', 'DeleteUserDefinedFunctionRequest$FunctionName' => 'The name of the function definition to be deleted.
', 'DeleteWorkflowRequest$Name' => 'Name of the workflow to be deleted.
', 'DeleteWorkflowResponse$Name' => 'Name of the workflow specified in input.
', 'DevEndpoint$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this DevEndpoint
.
The unique of the node within the workflow where the edge starts.
', 'Edge$DestinationId' => 'The unique of the node within the workflow where the edge ends.
', 'EncryptionAtRest$SseAwsKmsKeyId' => 'The ID of the KMS key to use for encryption at rest.
', 'ErrorByName$key' => NULL, 'ErrorDetail$ErrorCode' => 'The code associated with this error.
', 'EvaluatedMetricsMap$key' => NULL, 'FederatedDatabase$ConnectionName' => 'The name of the connection to the external metastore.
', 'FederatedTable$ConnectionName' => 'The name of the connection to the external metastore.
', 'FindMatchesTaskRunProperties$JobName' => 'The name assigned to the job for the Find Matches task run.
', 'GetBlueprintRequest$Name' => 'The name of the blueprint.
', 'GetBlueprintRunsRequest$BlueprintName' => 'The name of the blueprint.
', 'GetClassifierRequest$Name' => 'Name of the classifier to retrieve.
', 'GetColumnNamesList$member' => NULL, 'GetColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'GetColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'GetColumnStatisticsTaskRunsRequest$TableName' => 'The name of the table.
', 'GetConnectionRequest$Name' => 'The name of the connection definition to retrieve.
', 'GetCrawlerRequest$Name' => 'The name of the crawler to retrieve metadata for.
', 'GetCustomEntityTypeRequest$Name' => 'The name of the custom pattern that you want to retrieve.
', 'GetCustomEntityTypeResponse$Name' => 'The name of the custom pattern that you retrieved.
', 'GetCustomEntityTypeResponse$RegexString' => 'A regular expression string that is used for detecting sensitive data in a custom pattern.
', 'GetDataQualityResultResponse$RulesetName' => 'The name of the ruleset associated with the data quality result.
', 'GetDataQualityResultResponse$JobName' => 'The job name associated with the data quality result, if any.
', 'GetDataQualityRuleRecommendationRunResponse$CreatedRulesetName' => 'The name of the ruleset that was created by the run.
', 'GetDataQualityRulesetRequest$Name' => 'The name of the ruleset.
', 'GetDataQualityRulesetResponse$Name' => 'The name of the ruleset.
', 'GetDatabaseRequest$Name' => 'The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
', 'GetJobRequest$JobName' => 'The name of the job definition to retrieve.
', 'GetJobRunRequest$JobName' => 'Name of the job definition being run.
', 'GetJobRunsRequest$JobName' => 'The name of the job definition for which to retrieve all job runs.
', 'GetMLTransformResponse$Name' => 'The unique name given to the transform when it was created.
', 'GetPartitionIndexesRequest$DatabaseName' => 'Specifies the name of a database from which you want to retrieve partition indexes.
', 'GetPartitionIndexesRequest$TableName' => 'Specifies the name of a table for which you want to retrieve the partition indexes.
', 'GetPartitionRequest$DatabaseName' => 'The name of the catalog database where the partition resides.
', 'GetPartitionRequest$TableName' => 'The name of the partition\'s table.
', 'GetPartitionsRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetPartitionsRequest$TableName' => 'The name of the partitions\' table.
', 'GetSecurityConfigurationRequest$Name' => 'The name of the security configuration to retrieve.
', 'GetSessionRequest$Id' => 'The ID of the session.
', 'GetStatementRequest$SessionId' => 'The Session ID of the statement.
', 'GetTableOptimizerRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'GetTableOptimizerRequest$TableName' => 'The name of the table.
', 'GetTableOptimizerResponse$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'GetTableOptimizerResponse$TableName' => 'The name of the table.
', 'GetTableRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableRequest$Name' => 'The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionsRequest$DatabaseName' => 'The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'GetTableVersionsRequest$TableName' => 'The name of the table. For Hive compatibility, this name is entirely lowercase.
', 'GetTablesRequest$DatabaseName' => 'The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
', 'GetTriggerRequest$Name' => 'The name of the trigger to retrieve.
', 'GetTriggersRequest$DependentJobName' => 'The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.
', 'GetUnfilteredPartitionMetadataRequest$DatabaseName' => '(Required) Specifies the name of a database that contains the partition.
', 'GetUnfilteredPartitionMetadataRequest$TableName' => '(Required) Specifies the name of a table that contains the partition.
', 'GetUnfilteredPartitionsMetadataRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'GetUnfilteredPartitionsMetadataRequest$TableName' => 'The name of the table that contains the partition.
', 'GetUnfilteredTableMetadataRequest$DatabaseName' => '(Required) Specifies the name of a database that contains the table.
', 'GetUnfilteredTableMetadataRequest$Name' => '(Required) Specifies the name of a table for which you are requesting metadata.
', 'GetUsageProfileRequest$Name' => 'The name of the usage profile to retrieve.
', 'GetUsageProfileResponse$Name' => 'The name of the usage profile.
', 'GetUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function is located.
', 'GetUserDefinedFunctionRequest$FunctionName' => 'The name of the function.
', 'GetUserDefinedFunctionsRequest$DatabaseName' => 'The name of the catalog database where the functions are located. If none is provided, functions from all the databases across the catalog will be returned.
', 'GetUserDefinedFunctionsRequest$Pattern' => 'An optional function-name pattern string that filters the function definitions returned.
', 'GetWorkflowRequest$Name' => 'The name of the workflow to retrieve.
', 'GetWorkflowRunPropertiesRequest$Name' => 'Name of the workflow which was run.
', 'GetWorkflowRunRequest$Name' => 'Name of the workflow being run.
', 'GetWorkflowRunsRequest$Name' => 'Name of the workflow whose metadata of runs should be returned.
', 'GlueTable$DatabaseName' => 'A database name in the Glue Data Catalog.
', 'GlueTable$TableName' => 'A table name in the Glue Data Catalog.
', 'GlueTable$CatalogId' => 'A unique identifier for the Glue Data Catalog.
', 'GlueTable$ConnectionName' => 'The name of the connection to the Glue Data Catalog.
', 'GlueTableAdditionalOptions$key' => NULL, 'GrokClassifier$Name' => 'The name of the classifier.
', 'Job$Name' => 'The name you assign to this job definition.
', 'Job$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job.
The name of an Glue usage profile associated with the job.
', 'JobNameList$member' => NULL, 'JobRun$TriggerName' => 'The name of the trigger that started this job run.
', 'JobRun$JobName' => 'The name of the job definition being used in this run.
', 'JobRun$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job run.
The name of an Glue usage profile associated with the job run.
', 'JobUpdate$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job.
The name of the classifier.
', 'KeyList$member' => NULL, 'KeySchemaElement$Name' => 'The name of a partition key.
', 'ListCrawlsRequest$CrawlerName' => 'The name of the crawler whose runs you want to retrieve.
', 'ListStatementsRequest$SessionId' => 'The Session ID of the statements.
', 'ListTableOptimizerRunsRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'ListTableOptimizerRunsRequest$TableName' => 'The name of the table.
', 'ListTableOptimizerRunsResponse$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'ListTableOptimizerRunsResponse$TableName' => 'The name of the table.
', 'ListTriggersRequest$DependentJobName' => 'The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.
', 'MLTransform$Name' => 'A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
', 'MLUserDataEncryption$KmsKeyId' => 'The ID for the customer-provided KMS key.
', 'MatchCriteria$member' => NULL, 'MetricBasedObservation$MetricName' => 'The name of the data quality metric used for generating the observation.
', 'NameStringList$member' => NULL, 'NewRules$member' => NULL, 'Node$Name' => 'The name of the Glue component represented by the node.
', 'Node$UniqueId' => 'The unique Id assigned to the node within the workflow.
', 'NodeIdList$member' => NULL, 'Order$Column' => 'The name of the column.
', 'Partition$DatabaseName' => 'The name of the catalog database in which to create the partition.
', 'Partition$TableName' => 'The name of the database table in which to create the partition.
', 'PartitionIndex$IndexName' => 'The name of the partition index.
', 'PartitionIndexDescriptor$IndexName' => 'The name of the partition index.
', 'PhysicalConnectionRequirements$SubnetId' => 'The subnet ID used by the connection.
', 'PhysicalConnectionRequirements$AvailabilityZone' => 'The connection\'s Availability Zone.
', 'Predecessor$JobName' => 'The name of the job definition used by the predecessor job run.
', 'PutWorkflowRunPropertiesRequest$Name' => 'Name of the workflow which was run.
', 'ResumeWorkflowRunRequest$Name' => 'The name of the workflow to resume.
', 'RulesetNames$member' => NULL, 'RunStatementRequest$SessionId' => 'The Session Id of the statement to be run.
', 'SecurityConfiguration$Name' => 'The name of the security configuration.
', 'SecurityGroupIdList$member' => NULL, 'SerDeInfo$Name' => 'Name of the SerDe.
', 'SerDeInfo$SerializationLibrary' => 'Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe
.
The ID of the session.
', 'Session$SecurityConfiguration' => 'The name of the SecurityConfiguration structure to be used with the session.
', 'Session$ProfileName' => 'The name of an Glue usage profile associated with the session.
', 'SessionCommand$Name' => 'Specifies the name of the SessionCommand. Can be \'glueetl\' or \'gluestreaming\'.
', 'SessionIdList$member' => NULL, 'StartColumnStatisticsTaskRunRequest$DatabaseName' => 'The name of the database where the table resides.
', 'StartColumnStatisticsTaskRunRequest$TableName' => 'The name of the table to generate statistics.
', 'StartColumnStatisticsTaskRunRequest$Role' => 'The IAM role that the service assumes to generate statistics.
', 'StartColumnStatisticsTaskRunRequest$CatalogID' => 'The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
', 'StartColumnStatisticsTaskRunRequest$SecurityConfiguration' => 'Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
', 'StartCrawlerRequest$Name' => 'Name of the crawler to start.
', 'StartCrawlerScheduleRequest$CrawlerName' => 'Name of the crawler to schedule.
', 'StartDataQualityRuleRecommendationRunRequest$CreatedRulesetName' => 'A name for the ruleset.
', 'StartJobRunRequest$JobName' => 'The name of the job definition to use.
', 'StartJobRunRequest$SecurityConfiguration' => 'The name of the SecurityConfiguration
structure to be used with this job run.
The name of the trigger to start.
', 'StartTriggerResponse$Name' => 'The name of the trigger that was started.
', 'StartWorkflowRunRequest$Name' => 'The name of the workflow to start.
', 'StopColumnStatisticsTaskRunRequest$TableName' => 'The name of the table.
', 'StopCrawlerRequest$Name' => 'Name of the crawler to stop.
', 'StopCrawlerScheduleRequest$CrawlerName' => 'Name of the crawler whose schedule state to set.
', 'StopSessionRequest$Id' => 'The ID of the session to be stopped.
', 'StopSessionResponse$Id' => 'Returns the Id of the stopped session.
', 'StopTriggerRequest$Name' => 'The name of the trigger to stop.
', 'StopTriggerResponse$Name' => 'The name of the trigger that was stopped.
', 'StopWorkflowRunRequest$Name' => 'The name of the workflow to stop.
', 'Table$Name' => 'The table name. For Hive compatibility, this must be entirely lowercase.
', 'Table$DatabaseName' => 'The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
', 'Table$Owner' => 'The owner of the table.
', 'Table$CreatedBy' => 'The person or entity who created the table.
', 'TableError$TableName' => 'The name of the table. For Hive compatibility, this must be entirely lowercase.
', 'TableIdentifier$DatabaseName' => 'The name of the catalog database that contains the target table.
', 'TableIdentifier$Name' => 'The name of the target table.
', 'TableIdentifier$Region' => 'Region of the target table.
', 'TableInput$Name' => 'The table name. For Hive compatibility, this is folded to lowercase when it is stored.
', 'TableInput$Owner' => 'The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'TableVersionError$TableName' => 'The name of the table in question.
', 'TransformEncryption$TaskRunSecurityConfigurationName' => 'The name of the security configuration.
', 'TransformFilterCriteria$Name' => 'A unique transform name that is used to filter the machine learning transforms.
', 'Trigger$Name' => 'The name of the trigger.
', 'Trigger$WorkflowName' => 'The name of the workflow associated with the trigger.
', 'TriggerNameList$member' => NULL, 'TriggerUpdate$Name' => 'Reserved for future use.
', 'UpdateBlueprintResponse$Name' => 'Returns the name of the blueprint that was updated.
', 'UpdateColumnStatisticsForPartitionRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'UpdateColumnStatisticsForPartitionRequest$TableName' => 'The name of the partitions\' table.
', 'UpdateColumnStatisticsForTableRequest$DatabaseName' => 'The name of the catalog database where the partitions reside.
', 'UpdateColumnStatisticsForTableRequest$TableName' => 'The name of the partitions\' table.
', 'UpdateConnectionRequest$Name' => 'The name of the connection definition to update.
', 'UpdateCrawlerRequest$Name' => 'Name of the new crawler.
', 'UpdateCrawlerScheduleRequest$CrawlerName' => 'The name of the crawler whose schedule to update.
', 'UpdateCsvClassifierRequest$Name' => 'The name of the classifier.
', 'UpdateDataQualityRulesetRequest$Name' => 'The name of the data quality ruleset.
', 'UpdateDataQualityRulesetResponse$Name' => 'The name of the data quality ruleset.
', 'UpdateDatabaseRequest$Name' => 'The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
', 'UpdateGrokClassifierRequest$Name' => 'The name of the GrokClassifier
.
The name of the Glue job to be synchronized to or from the remote repository.
', 'UpdateJobFromSourceControlRequest$RepositoryName' => 'The name of the remote repository that contains the job artifacts. For BitBucket providers, RepositoryName
should include WorkspaceName
. Use the format <WorkspaceName>/<RepositoryName>
.
The owner of the remote repository that contains the job artifacts.
', 'UpdateJobFromSourceControlRequest$BranchName' => 'An optional branch in the remote repository.
', 'UpdateJobFromSourceControlRequest$Folder' => 'An optional folder in the remote repository.
', 'UpdateJobFromSourceControlResponse$JobName' => 'The name of the Glue job.
', 'UpdateJobRequest$JobName' => 'The name of the job definition to update.
', 'UpdateJobResponse$JobName' => 'Returns the name of the updated job definition.
', 'UpdateJsonClassifierRequest$Name' => 'The name of the classifier.
', 'UpdateMLTransformRequest$Name' => 'The unique name that you gave the transform when you created it.
', 'UpdatePartitionRequest$DatabaseName' => 'The name of the catalog database in which the table in question resides.
', 'UpdatePartitionRequest$TableName' => 'The name of the table in which the partition to be updated is located.
', 'UpdateSourceControlFromJobRequest$JobName' => 'The name of the Glue job to be synchronized to or from the remote repository.
', 'UpdateSourceControlFromJobRequest$RepositoryName' => 'The name of the remote repository that contains the job artifacts. For BitBucket providers, RepositoryName
should include WorkspaceName
. Use the format <WorkspaceName>/<RepositoryName>
.
The owner of the remote repository that contains the job artifacts.
', 'UpdateSourceControlFromJobRequest$BranchName' => 'An optional branch in the remote repository.
', 'UpdateSourceControlFromJobRequest$Folder' => 'An optional folder in the remote repository.
', 'UpdateSourceControlFromJobResponse$JobName' => 'The name of the Glue job.
', 'UpdateTableOptimizerRequest$DatabaseName' => 'The name of the database in the catalog in which the table resides.
', 'UpdateTableOptimizerRequest$TableName' => 'The name of the table.
', 'UpdateTableRequest$DatabaseName' => 'The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.
', 'UpdateTriggerRequest$Name' => 'The name of the trigger to update.
', 'UpdateUsageProfileRequest$Name' => 'The name of the usage profile.
', 'UpdateUsageProfileResponse$Name' => 'The name of the usage profile that was updated.
', 'UpdateUserDefinedFunctionRequest$DatabaseName' => 'The name of the catalog database where the function to be updated is located.
', 'UpdateUserDefinedFunctionRequest$FunctionName' => 'The name of the function.
', 'UpdateWorkflowRequest$Name' => 'Name of the workflow to be updated.
', 'UpdateWorkflowResponse$Name' => 'The name of the workflow which was specified in input.
', 'UpdateXMLClassifierRequest$Name' => 'The name of the classifier.
', 'UsageProfileDefinition$Name' => 'The name of the usage profile.
', 'UserDefinedFunction$FunctionName' => 'The name of the function.
', 'UserDefinedFunction$DatabaseName' => 'The name of the catalog database that contains the function.
', 'UserDefinedFunction$ClassName' => 'The Java class that contains the function code.
', 'UserDefinedFunction$OwnerName' => 'The owner of the function.
', 'UserDefinedFunctionInput$FunctionName' => 'The name of the function.
', 'UserDefinedFunctionInput$ClassName' => 'The Java class that contains the function code.
', 'UserDefinedFunctionInput$OwnerName' => 'The owner of the function.
', 'ViewRepresentation$ValidationConnection' => 'The name of the connection to be used to validate the specific representation of the view.
', 'ViewRepresentationInput$ValidationConnection' => 'The name of the connection to be used to validate the specific representation of the view.
', 'Workflow$Name' => 'The name of the workflow.
', 'WorkflowNames$member' => NULL, 'WorkflowRun$Name' => 'Name of the workflow that was run.
', 'XMLClassifier$Name' => 'The name of the classifier.
', ], ], 'NameStringList' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteConnectionResponse$Succeeded' => 'A list of names of the connection definitions that were successfully deleted.
', 'GetUnfilteredPartitionMetadataResponse$AuthorizedColumns' => 'A list of column names that the user has been granted access to.
', 'GetUnfilteredTableMetadataResponse$AuthorizedColumns' => 'A list of column names that the user has been granted access to.
', 'SkewedInfo$SkewedColumnNames' => 'A list of names of columns that contain skewed values.
', 'StorageDescriptor$BucketColumns' => 'A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
', 'UnfilteredPartition$AuthorizedColumns' => 'The list of columns the user has permissions to access.
', ], ], 'NewRules' => [ 'base' => NULL, 'refs' => [ 'MetricBasedObservation$NewRules' => 'A list of new data quality rules generated as part of the observation based on the data quality metric value.
', ], ], 'NoScheduleException' => [ 'base' => 'There is no applicable schedule.
', 'refs' => [], ], 'Node' => [ 'base' => 'A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
', 'refs' => [ 'NodeList$member' => NULL, ], ], 'NodeId' => [ 'base' => NULL, 'refs' => [ 'CodeGenConfigurationNodes$key' => NULL, 'ManyInputs$member' => NULL, 'Merge$Source' => 'The source DynamicFrame
that will be merged with a staging DynamicFrame
.
A table, or a column in a table.
', 'TwoInputs$member' => NULL, ], ], 'NodeIdList' => [ 'base' => NULL, 'refs' => [ 'ResumeWorkflowRunRequest$NodeIds' => 'A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
', 'ResumeWorkflowRunResponse$NodeIds' => 'A list of the node IDs for the nodes that were actually restarted.
', ], ], 'NodeList' => [ 'base' => NULL, 'refs' => [ 'WorkflowGraph$Nodes' => 'A list of the the Glue components belong to the workflow represented as nodes.
', ], ], 'NodeName' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Name' => 'The name of the transform node.
', 'AmazonRedshiftSource$Name' => 'The name of the Amazon Redshift source.
', 'AmazonRedshiftTarget$Name' => 'The name of the Amazon Redshift target.
', 'ApplyMapping$Name' => 'The name of the transform node.
', 'AthenaConnectorSource$Name' => 'The name of the data source.
', 'BasicCatalogTarget$Name' => 'The name of your data target.
', 'CatalogDeltaSource$Name' => 'The name of the Delta Lake data source.
', 'CatalogHudiSource$Name' => 'The name of the Hudi data source.
', 'CatalogKafkaSource$Name' => 'The name of the data store.
', 'CatalogKinesisSource$Name' => 'The name of the data source.
', 'CatalogSource$Name' => 'The name of the data store.
', 'ConnectorDataSource$Name' => 'The name of this source node.
', 'ConnectorDataTarget$Name' => 'The name of this target node.
', 'CustomCode$Name' => 'The name of the transform node.
', 'DQDLAliases$key' => NULL, 'DirectJDBCSource$Name' => 'The name of the JDBC source connection.
', 'DirectKafkaSource$Name' => 'The name of the data store.
', 'DirectKinesisSource$Name' => 'The name of the data source.
', 'DropDuplicates$Name' => 'The name of the transform node.
', 'DropFields$Name' => 'The name of the transform node.
', 'DropNullFields$Name' => 'The name of the transform node.
', 'DynamoDBCatalogSource$Name' => 'The name of the data source.
', 'EvaluateDataQuality$Name' => 'The name of the data quality evaluation.
', 'EvaluateDataQualityMultiFrame$Name' => 'The name of the data quality evaluation.
', 'FillMissingValues$Name' => 'The name of the transform node.
', 'Filter$Name' => 'The name of the transform node.
', 'GovernedCatalogSource$Name' => 'The name of the data store.
', 'GovernedCatalogTarget$Name' => 'The name of the data target.
', 'JDBCConnectorSource$Name' => 'The name of the data source.
', 'JDBCConnectorTarget$Name' => 'The name of the data target.
', 'Join$Name' => 'The name of the transform node.
', 'Merge$Name' => 'The name of the transform node.
', 'MicrosoftSQLServerCatalogSource$Name' => 'The name of the data source.
', 'MicrosoftSQLServerCatalogTarget$Name' => 'The name of the data target.
', 'MySQLCatalogSource$Name' => 'The name of the data source.
', 'MySQLCatalogTarget$Name' => 'The name of the data target.
', 'OracleSQLCatalogSource$Name' => 'The name of the data source.
', 'OracleSQLCatalogTarget$Name' => 'The name of the data target.
', 'PIIDetection$Name' => 'The name of the transform node.
', 'PostgreSQLCatalogSource$Name' => 'The name of the data source.
', 'PostgreSQLCatalogTarget$Name' => 'The name of the data target.
', 'Recipe$Name' => 'The name of the Glue Studio node.
', 'RedshiftSource$Name' => 'The name of the Amazon Redshift data store.
', 'RedshiftTarget$Name' => 'The name of the data target.
', 'RelationalCatalogSource$Name' => 'The name of the data source.
', 'RenameField$Name' => 'The name of the transform node.
', 'S3CatalogDeltaSource$Name' => 'The name of the Delta Lake data source.
', 'S3CatalogHudiSource$Name' => 'The name of the Hudi data source.
', 'S3CatalogSource$Name' => 'The name of the data store.
', 'S3CatalogTarget$Name' => 'The name of the data target.
', 'S3CsvSource$Name' => 'The name of the data store.
', 'S3DeltaCatalogTarget$Name' => 'The name of the data target.
', 'S3DeltaDirectTarget$Name' => 'The name of the data target.
', 'S3DeltaSource$Name' => 'The name of the Delta Lake source.
', 'S3DirectTarget$Name' => 'The name of the data target.
', 'S3GlueParquetTarget$Name' => 'The name of the data target.
', 'S3HudiCatalogTarget$Name' => 'The name of the data target.
', 'S3HudiDirectTarget$Name' => 'The name of the data target.
', 'S3HudiSource$Name' => 'The name of the Hudi source.
', 'S3JsonSource$Name' => 'The name of the data store.
', 'S3ParquetSource$Name' => 'The name of the data store.
', 'SelectFields$Name' => 'The name of the transform node.
', 'SelectFromCollection$Name' => 'The name of the transform node.
', 'SnowflakeSource$Name' => 'The name of the Snowflake data source.
', 'SnowflakeTarget$Name' => 'The name of the Snowflake target.
', 'SparkConnectorSource$Name' => 'The name of the data source.
', 'SparkConnectorTarget$Name' => 'The name of the data target.
', 'SparkSQL$Name' => 'The name of the transform node.
', 'Spigot$Name' => 'The name of the transform node.
', 'SplitFields$Name' => 'The name of the transform node.
', 'Union$Name' => 'The name of the transform node.
', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'Node$Type' => 'The type of Glue component represented by the node.
', ], ], 'NonNegativeDouble' => [ 'base' => NULL, 'refs' => [ 'BinaryColumnStatisticsData$AverageLength' => 'The average bit sequence length in the column.
', 'ColumnStatisticsTaskRun$DPUSeconds' => 'The calculated DPU usage in seconds for all autoscaled workers.
', 'CrawlerHistory$DPUHour' => 'The number of data processing units (DPU) used in hours for the crawl.
', 'CrawlerMetrics$TimeLeftSeconds' => 'The estimated time left to complete a running crawl.
', 'CrawlerMetrics$LastRuntimeSeconds' => 'The duration of the crawler\'s most recent run, in seconds.
', 'CrawlerMetrics$MedianRuntimeSeconds' => 'The median duration of this crawler\'s runs, in seconds.
', 'StringColumnStatisticsData$AverageLength' => 'The average string length in the column.
', ], ], 'NonNegativeInt' => [ 'base' => NULL, 'refs' => [ 'SelectFromCollection$Index' => 'The index for the DynamicFrame to be selected.
', ], ], 'NonNegativeInteger' => [ 'base' => NULL, 'refs' => [ 'CrawlerMetrics$TablesCreated' => 'The number of tables created by this crawler.
', 'CrawlerMetrics$TablesUpdated' => 'The number of tables updated by this crawler.
', 'CrawlerMetrics$TablesDeleted' => 'The number of tables deleted by this crawler.
', 'Segment$SegmentNumber' => 'The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber
values range from 0 through 3.
The retention time for this table.
', 'TableInput$Retention' => 'The retention time for this table.
', ], ], 'NonNegativeLong' => [ 'base' => NULL, 'refs' => [ 'BinaryColumnStatisticsData$MaximumLength' => 'The size of the longest bit sequence in the column.
', 'BinaryColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'BooleanColumnStatisticsData$NumberOfTrues' => 'The number of true values in the column.
', 'BooleanColumnStatisticsData$NumberOfFalses' => 'The number of false values in the column.
', 'BooleanColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DateColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DateColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'DecimalColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DecimalColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'DoubleColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'DoubleColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'LongColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'LongColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', 'StringColumnStatisticsData$MaximumLength' => 'The size of the longest string in the column.
', 'StringColumnStatisticsData$NumberOfNulls' => 'The number of null values in the column.
', 'StringColumnStatisticsData$NumberOfDistinctValues' => 'The number of distinct values in a column.
', ], ], 'NotificationProperty' => [ 'base' => 'Specifies configuration properties of a notification.
', 'refs' => [ 'Action$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', 'CreateJobRequest$NotificationProperty' => 'Specifies configuration properties of a job notification.
', 'Job$NotificationProperty' => 'Specifies configuration properties of a job notification.
', 'JobRun$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', 'JobUpdate$NotificationProperty' => 'Specifies the configuration properties of a job notification.
', 'StartJobRunRequest$NotificationProperty' => 'Specifies configuration properties of a job run notification.
', ], ], 'NotifyDelayAfter' => [ 'base' => NULL, 'refs' => [ 'NotificationProperty$NotifyDelayAfter' => 'After a job run starts, the number of minutes to wait before sending a job run delay notification.
', ], ], 'NullCheckBoxList' => [ 'base' => 'Represents whether certain values are recognized as null values for removal.
', 'refs' => [ 'DropNullFields$NullCheckBoxList' => 'A structure that represents whether certain values are recognized as null values for removal.
', ], ], 'NullValueField' => [ 'base' => 'Represents a custom null value such as a zeros or other value being used as a null placeholder unique to the dataset.
', 'refs' => [ 'NullValueFields$member' => NULL, ], ], 'NullValueFields' => [ 'base' => NULL, 'refs' => [ 'DropNullFields$NullTextList' => 'A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The DropNullFields
transform removes custom null values only if both the value of the null placeholder and the datatype match the data.
All columns request for audit.
', 'BatchGetBlueprintsRequest$IncludeBlueprint' => 'Specifies whether or not to include the blueprint in the response.
', 'BatchGetBlueprintsRequest$IncludeParameterSpec' => 'Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.
', 'BatchGetWorkflowsRequest$IncludeGraph' => 'Specifies whether to include a graph when returning the workflow resource metadata.
', 'CreateCsvClassifierRequest$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true.
', 'CreateCsvClassifierRequest$AllowSingleColumn' => 'Enables the processing of files that contain only one column.
', 'CreateCsvClassifierRequest$CustomDatatypeConfigured' => 'Enables the configuration of custom datatypes.
', 'CsvClassifier$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true
.
Enables the processing of files that contain only one column.
', 'CsvClassifier$CustomDatatypeConfigured' => 'Enables the custom datatype to be configured.
', 'DataQualityEvaluationRunAdditionalRunOptions$CloudWatchMetricsEnabled' => 'Whether or not to enable CloudWatch metrics.
', 'DeltaTarget$WriteManifest' => 'Specifies whether to write the manifest files to the Delta table path.
', 'DeltaTarget$CreateNativeDeltaTable' => 'Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
', 'DynamoDBTarget$scanAll' => 'Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true
means to scan all records, while a value of false
means to sample the records. If no value is specified, the value defaults to true
.
Indicates whether or not the exception relates to a federated source.
', 'FindMatchesParameters$EnforceProvidedLabels' => 'The value to switch on or off to force the output to match the provided labels from users. If the value is True
, the find matches
transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False
, the find matches
transform does not ensure all the labels provided are respected, and the results rely on the trained model.
Note that setting this value to true may increase the conflation execution time.
', 'GetBlueprintRequest$IncludeBlueprint' => 'Specifies whether or not to include the blueprint in the response.
', 'GetBlueprintRequest$IncludeParameterSpec' => 'Specifies whether or not to include the parameter specification.
', 'GetWorkflowRequest$IncludeGraph' => 'Specifies whether to include a graph when returning the workflow resource metadata.
', 'GetWorkflowRunRequest$IncludeGraph' => 'Specifies whether to include the workflow graph in response or not.
', 'GetWorkflowRunsRequest$IncludeGraph' => 'Specifies whether to include the workflow graph in response or not.
', 'InvalidInputException$FromFederationSource' => 'Indicates whether or not the exception relates to a federated source.
', 'LakeFormationConfiguration$UseLakeFormationCredentials' => 'Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
', 'MongoDBTarget$ScanAll' => 'Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true
means to scan all records, while a value of false
means to sample the records. If no value is specified, the value defaults to true
.
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
', 'TableOptimizerConfiguration$enabled' => 'Whether table optimization is enabled.
', 'UpdateCsvClassifierRequest$DisableValueTrimming' => 'Specifies not to trim values before identifying the type of column values. The default value is true.
', 'UpdateCsvClassifierRequest$AllowSingleColumn' => 'Enables the processing of files that contain only one column.
', 'UpdateCsvClassifierRequest$CustomDatatypeConfigured' => 'Specifies the configuration of custom datatypes.
', 'ViewDefinition$IsProtected' => 'You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine\'s documentation to understand the guarantees provided, if any.
', 'ViewDefinitionInput$IsProtected' => 'You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine\'s documentation to understand the guarantees provided, if any.
', 'ViewRepresentation$IsStale' => 'Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
', ], ], 'NullableDouble' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$MaxCapacity' => 'For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
MaxCapacity
and NumberOfWorkers
must both be at least 1.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
', 'DataQualityMetricValues$ActualValue' => 'The actual value of the data quality metric.
', 'DataQualityMetricValues$ExpectedValue' => 'The expected value of the data quality metric according to the analysis of historical data.
', 'DataQualityMetricValues$LowerLimit' => 'The lower limit of the data quality metric value according to the analysis of historical data.
', 'DataQualityMetricValues$UpperLimit' => 'The upper limit of the data quality metric value according to the analysis of historical data.
', 'DynamoDBTarget$scanRate' => 'The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
', 'EvaluatedMetricsMap$value' => NULL, 'GetMLTransformResponse$MaxCapacity' => 'The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
This field can be set for either job runs with execution class FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X
, 2 for G.2X
, or 0.25 for G.025X
workers). This value may be different than the executionEngineRuntime
* MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity
. Therefore, it is possible that the value of DPUSeconds
is less than executionEngineRuntime
* MaxCapacity
.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
MaxCapacity
and NumberOfWorkers
must both be at least 1.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
', 'Session$ExecutionTime' => 'The total time the session ran for.
', 'Session$DPUSeconds' => 'The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
', 'StartJobRunRequest$MaxCapacity' => 'For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
When the WorkerType
field is set to a value other than Standard
, the MaxCapacity
field is set automatically and becomes read-only.
The number of workers of a defined workerType
that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X
, and 149 for G.2X
.
The number of workers of a defined workerType
that are allocated to the development endpoint.
The number of workers of a defined workerType
that are allocated when a job runs.
The number of workers of a defined workerType
that are allocated when this task runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
The maximum number of times to retry a task for this transform after a task run fails.
', 'CreateSessionRequest$NumberOfWorkers' => 'The number of workers of a defined WorkerType
to use for the session.
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', 'DataQualityRulesetListDetails$RuleCount' => 'The number of rules in the ruleset.
', 'DevEndpoint$NumberOfWorkers' => 'The number of workers of a defined workerType
that are allocated to the development endpoint.
The maximum number of workers you can define are 299 for G.1X
, and 149 for G.2X
.
The number of G.1X
workers to be used in the run. The default is 5.
The number of G.1X
workers to be used in the run. The default is 5.
The number of workers of a defined workerType
that are allocated when this task runs.
The maximum number of times to retry a task for this transform after a task run fails.
', 'HudiTarget$MaximumTraversalDepth' => 'The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
', 'IcebergTarget$MaximumTraversalDepth' => 'The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
', 'Job$NumberOfWorkers' => 'The number of workers of a defined workerType
that are allocated when a job runs.
The number of workers of a defined workerType
that are allocated when a job runs.
The number of workers of a defined workerType
that are allocated when a job runs.
The number of workers of a defined workerType
that are allocated when a task of the transform runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
The maximum number of times to retry after an MLTaskRun
of the machine learning transform fails.
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
', 'Session$NumberOfWorkers' => 'The number of workers of a defined WorkerType
to use for the session.
The number of G.1X
workers to be used in the run. The default is 5.
The number of G.1X
workers to be used in the run. The default is 5.
The number of workers of a defined workerType
that are allocated when a job runs.
Number of events in the batch.
', 'StartingEventBatchCondition$BatchWindow' => 'Duration of the batch window in seconds.
', 'UpdateMLTransformRequest$NumberOfWorkers' => 'The number of workers of a defined workerType
that are allocated when this task runs.
The maximum number of times to retry a task for this transform after a task run fails.
', 'UpdateWorkflowRequest$MaxConcurrentRuns' => 'You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', 'Workflow$MaxConcurrentRuns' => 'You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
', ], ], 'NullableString' => [ 'base' => NULL, 'refs' => [ 'QuerySessionContext$ClusterId' => 'An identifier string for the consumer cluster.
', ], ], 'OAuth2ClientApplication' => [ 'base' => 'The OAuth2 client app used for the connection.
', 'refs' => [ 'OAuth2Properties$OAuth2ClientApplication' => 'The client application type. For example, AWS_MANAGED or USER_MANAGED.
', 'OAuth2PropertiesInput$OAuth2ClientApplication' => 'The client application type in the CreateConnection request. For example, AWS_MANAGED
or USER_MANAGED
.
The OAuth2 grant type. For example, AUTHORIZATION_CODE
, JWT_BEARER
, or CLIENT_CREDENTIALS
.
The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE
, JWT_BEARER
, or CLIENT_CREDENTIALS
.
A structure containing properties for OAuth2 authentication.
', 'refs' => [ 'AuthenticationConfiguration$OAuth2Properties' => 'The properties for OAuth2 authentication.
', ], ], 'OAuth2PropertiesInput' => [ 'base' => 'A structure containing properties for OAuth2 in the CreateConnection request.
', 'refs' => [ 'AuthenticationConfigurationInput$OAuth2Properties' => 'The properties for OAuth2 authentication in the CreateConnection request.
', ], ], 'OneInput' => [ 'base' => NULL, 'refs' => [ 'Aggregate$Inputs' => 'Specifies the fields and rows to use as inputs for the aggregate transform.
', 'AmazonRedshiftTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'ApplyMapping$Inputs' => 'The data inputs identified by their node names.
', 'BasicCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'ConnectorDataTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'DropDuplicates$Inputs' => 'The data inputs identified by their node names.
', 'DropFields$Inputs' => 'The data inputs identified by their node names.
', 'DropNullFields$Inputs' => 'The data inputs identified by their node names.
', 'DynamicTransform$Inputs' => 'Specifies the inputs for the dynamic transform that are required.
', 'EvaluateDataQuality$Inputs' => 'The inputs of your data quality evaluation.
', 'FillMissingValues$Inputs' => 'The data inputs identified by their node names.
', 'Filter$Inputs' => 'The data inputs identified by their node names.
', 'GovernedCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'JDBCConnectorTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'MicrosoftSQLServerCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'MySQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'OracleSQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'PIIDetection$Inputs' => 'The node ID inputs to the transform.
', 'PostgreSQLCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'Recipe$Inputs' => 'The nodes that are inputs to the recipe node, identified by id.
', 'RedshiftTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'RenameField$Inputs' => 'The data inputs identified by their node names.
', 'S3CatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DeltaCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DeltaDirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3DirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3GlueParquetTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3HudiCatalogTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'S3HudiDirectTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'SelectFields$Inputs' => 'The data inputs identified by their node names.
', 'SelectFromCollection$Inputs' => 'The data inputs identified by their node names.
', 'SnowflakeTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'SparkConnectorTarget$Inputs' => 'The nodes that are inputs to the data target.
', 'Spigot$Inputs' => 'The data inputs identified by their node names.
', 'SplitFields$Inputs' => 'The data inputs identified by their node names.
', ], ], 'OpenTableFormatInput' => [ 'base' => 'A structure representing an open format table.
', 'refs' => [ 'CreateTableRequest$OpenTableFormatInput' => 'Specifies an OpenTableFormatInput
structure when creating an open format table.
The operation is not available in the region.
', 'refs' => [], ], 'OperationTimeoutException' => [ 'base' => 'The operation timed out.
', 'refs' => [], ], 'Option' => [ 'base' => 'Specifies an option value.
', 'refs' => [ 'AmazonRedshiftNodeData$Connection' => 'The Glue connection to the Redshift cluster.
', 'AmazonRedshiftNodeData$Schema' => 'The Redshift schema name when working with a direct connection.
', 'AmazonRedshiftNodeData$Table' => 'The Redshift table name when working with a direct connection.
', 'AmazonRedshiftNodeData$CatalogDatabase' => 'The name of the Glue Data Catalog database when working with a data catalog.
', 'AmazonRedshiftNodeData$CatalogTable' => 'The Glue Data Catalog table name when working with a data catalog.
', 'AmazonRedshiftNodeData$IamRole' => 'Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
', 'OptionList$member' => NULL, 'SnowflakeNodeData$Connection' => 'Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
', 'SnowflakeNodeData$IamRole' => 'Not currently used.
', ], ], 'OptionList' => [ 'base' => NULL, 'refs' => [ 'AmazonRedshiftNodeData$TableSchema' => 'The array of schema output for a given node.
', 'AmazonRedshiftNodeData$SelectedColumns' => 'The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
', 'SnowflakeNodeData$SelectedColumns' => 'Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value
, label
and description
keys. Each structure describes a column.
Manually defines the target schema for the node. A list of structures with value
, label
and description
keys. Each structure defines a column.
Specifies an Oracle data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$OracleSQLCatalogSource' => 'Specifies an Oracle data source in the Glue Data Catalog.
', ], ], 'OracleSQLCatalogTarget' => [ 'base' => 'Specifies a target that uses Oracle SQL.
', 'refs' => [ 'CodeGenConfigurationNode$OracleSQLCatalogTarget' => 'Specifies a target that uses Oracle SQL.
', ], ], 'OrchestrationArgumentsMap' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$DefaultArguments' => 'A map array of key-value pairs. Max is 75 pairs.
', 'Session$DefaultArguments' => 'A map array of key-value pairs. Max is 75 pairs.
', ], ], 'OrchestrationArgumentsValue' => [ 'base' => NULL, 'refs' => [ 'OrchestrationArgumentsMap$value' => NULL, ], ], 'OrchestrationIAMRoleArn' => [ 'base' => NULL, 'refs' => [ 'BlueprintRun$RoleArn' => 'The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
', 'StartBlueprintRunRequest$RoleArn' => 'Specifies the IAM role used to create the workflow.
', ], ], 'OrchestrationNameString' => [ 'base' => NULL, 'refs' => [ 'BatchGetBlueprintNames$member' => NULL, 'Blueprint$Name' => 'The name of the blueprint.
', 'BlueprintDetails$BlueprintName' => 'The name of the blueprint.
', 'BlueprintNames$member' => NULL, 'BlueprintRun$BlueprintName' => 'The name of the blueprint.
', 'CancelStatementRequest$RequestOrigin' => 'The origin of the request to cancel the statement.
', 'CreateBlueprintRequest$Name' => 'The name of the blueprint.
', 'CreateSessionRequest$RequestOrigin' => 'The origin of the request.
', 'DeleteSessionRequest$RequestOrigin' => 'The name of the origin of the delete session request.
', 'GetBlueprintRunRequest$BlueprintName' => 'The name of the blueprint.
', 'GetSessionRequest$RequestOrigin' => 'The origin of the request.
', 'GetStatementRequest$RequestOrigin' => 'The origin of the request.
', 'ListSessionsRequest$RequestOrigin' => 'The origin of the request.
', 'ListStatementsRequest$RequestOrigin' => 'The origin of the request to list statements.
', 'OrchestrationArgumentsMap$key' => NULL, 'RunStatementRequest$RequestOrigin' => 'The origin of the request.
', 'StartBlueprintRunRequest$BlueprintName' => 'The name of the blueprint.
', 'StopSessionRequest$RequestOrigin' => 'The origin of the request.
', 'UpdateBlueprintRequest$Name' => 'The name of the blueprint.
', ], ], 'OrchestrationPageSize200' => [ 'base' => NULL, 'refs' => [ 'GetJobRunsRequest$MaxResults' => 'The maximum size of the response.
', 'GetTriggersRequest$MaxResults' => 'The maximum size of the response.
', 'ListTriggersRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListUsageProfilesRequest$MaxResults' => 'The maximum number of usage profiles to return in a single response.
', ], ], 'OrchestrationPageSize25' => [ 'base' => NULL, 'refs' => [ 'ListBlueprintsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListWorkflowsRequest$MaxResults' => 'The maximum size of a list to return.
', ], ], 'OrchestrationRoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$Role' => 'The IAM Role ARN
', 'Session$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
', ], ], 'OrchestrationS3Location' => [ 'base' => NULL, 'refs' => [ 'CreateBlueprintRequest$BlueprintLocation' => 'Specifies a path in Amazon S3 where the blueprint is published.
', 'UpdateBlueprintRequest$BlueprintLocation' => 'Specifies a path in Amazon S3 where the blueprint is published.
', ], ], 'OrchestrationStatementCodeString' => [ 'base' => NULL, 'refs' => [ 'RunStatementRequest$Code' => 'The statement code to be run.
', ], ], 'OrchestrationStringList' => [ 'base' => NULL, 'refs' => [ 'ConnectionsList$Connections' => 'A list of connections used by the job.
', 'StatementOutput$Traceback' => 'The traceback of the output.
', ], ], 'OrchestrationToken' => [ 'base' => NULL, 'refs' => [ 'ListSessionsRequest$NextToken' => 'The token for the next set of results, or null if there are no more result.
', 'ListSessionsResponse$NextToken' => 'The token for the next set of results, or null if there are no more result.
', 'ListStatementsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListStatementsResponse$NextToken' => 'A continuation token, if not all statements have yet been returned.
', 'ListUsageProfilesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'ListUsageProfilesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', ], ], 'Order' => [ 'base' => 'Specifies the sort order of a sorted column.
', 'refs' => [ 'OrderList$member' => NULL, ], ], 'OrderList' => [ 'base' => NULL, 'refs' => [ 'StorageDescriptor$SortColumns' => 'A list specifying the sort order of each bucket in the table.
', ], ], 'OtherMetadataValueList' => [ 'base' => NULL, 'refs' => [ 'MetadataInfo$OtherMetadataValueList' => 'Other metadata belonging to the same metadata key.
', ], ], 'OtherMetadataValueListItem' => [ 'base' => 'A structure containing other metadata for a schema version belonging to the same metadata key.
', 'refs' => [ 'OtherMetadataValueList$member' => NULL, ], ], 'PIIDetection' => [ 'base' => 'Specifies a transform that identifies, removes or masks PII data.
', 'refs' => [ 'CodeGenConfigurationNode$PIIDetection' => 'Specifies a transform that identifies, removes or masks PII data.
', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'GetBlueprintRunsRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetClassifiersRequest$MaxResults' => 'The size of the list to return (optional).
', 'GetColumnStatisticsTaskRunsRequest$MaxResults' => 'The maximum size of the response.
', 'GetConnectionsRequest$MaxResults' => 'The maximum number of connections to return in one response.
', 'GetCrawlerMetricsRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetCrawlersRequest$MaxResults' => 'The number of crawlers to return on each call.
', 'GetDevEndpointsRequest$MaxResults' => 'The maximum size of information to return.
', 'GetJobsRequest$MaxResults' => 'The maximum size of the response.
', 'GetMLTaskRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetMLTransformsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetPartitionsRequest$MaxResults' => 'The maximum number of partitions to return in a single response.
', 'GetResourcePoliciesRequest$MaxResults' => 'The maximum size of a list to return.
', 'GetSecurityConfigurationsRequest$MaxResults' => 'The maximum number of results to return.
', 'GetUnfilteredPartitionsMetadataRequest$MaxResults' => 'The maximum number of partitions to return in a single response.
', 'GetWorkflowRunsRequest$MaxResults' => 'The maximum number of workflow runs to be included in the response.
', 'ListColumnStatisticsTaskRunsRequest$MaxResults' => 'The maximum size of the response.
', 'ListCrawlersRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListCrawlsRequest$MaxResults' => 'The maximum number of results to return. The default is 20, and maximum is 100.
', 'ListCustomEntityTypesRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityResultsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRuleRecommendationRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRulesetEvaluationRunsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDataQualityRulesetsRequest$MaxResults' => 'The maximum number of results to return.
', 'ListDevEndpointsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListJobsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListMLTransformsRequest$MaxResults' => 'The maximum size of a list to return.
', 'ListSessionsRequest$MaxResults' => 'The maximum number of results.
', 'SearchTablesRequest$MaxResults' => 'The maximum number of tables to return in a single response.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'GetMLTaskRunsRequest$NextToken' => 'A token for pagination of the results. The default is empty.
', 'GetMLTaskRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'GetMLTransformsRequest$NextToken' => 'A paginated token to offset the results.
', 'GetMLTransformsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListCustomEntityTypesRequest$NextToken' => 'A paginated token to offset the results.
', 'ListCustomEntityTypesResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityResultsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityResultsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRuleRecommendationRunsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRuleRecommendationRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRulesetEvaluationRunsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRulesetEvaluationRunsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListDataQualityRulesetsRequest$NextToken' => 'A paginated token to offset the results.
', 'ListDataQualityRulesetsResponse$NextToken' => 'A pagination token, if more results are available.
', 'ListMLTransformsRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListMLTransformsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', ], ], 'ParamType' => [ 'base' => NULL, 'refs' => [ 'TransformConfigParameter$Type' => 'Specifies the parameter type in the config file of the dynamic transform.
', 'TransformConfigParameter$ListType' => 'Specifies the list type of the parameter in the config file of the dynamic transform.
', ], ], 'ParametersMap' => [ 'base' => NULL, 'refs' => [ 'Column$Parameters' => 'These key-value pairs define properties associated with the column.
', 'Database$Parameters' => 'These key-value pairs define parameters and properties of the database.
', 'DatabaseInput$Parameters' => 'These key-value pairs define parameters and properties of the database.
These key-value pairs define parameters and properties of the database.
', 'Partition$Parameters' => 'These key-value pairs define partition parameters.
', 'PartitionInput$Parameters' => 'These key-value pairs define partition parameters.
', 'SerDeInfo$Parameters' => 'These key-value pairs define initialization parameters for the SerDe.
', 'StorageDescriptor$Parameters' => 'The user-supplied properties in key-value form.
', 'Table$Parameters' => 'These key-value pairs define properties associated with the table.
', 'TableInput$Parameters' => 'These key-value pairs define properties associated with the table.
', ], ], 'ParametersMapValue' => [ 'base' => NULL, 'refs' => [ 'ParametersMap$value' => NULL, ], ], 'ParquetCompressionType' => [ 'base' => NULL, 'refs' => [ 'S3GlueParquetTarget$Compression' => 'Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are "gzip"
and "bzip"
).
Represents a slice of table data.
', 'refs' => [ 'GetPartitionResponse$Partition' => 'The requested information, in the form of a Partition
object.
A Partition object containing the partition metadata.
', 'PartitionList$member' => NULL, 'UnfilteredPartition$Partition' => 'The partition object.
', ], ], 'PartitionError' => [ 'base' => 'Contains information about a partition error.
', 'refs' => [ 'PartitionErrors$member' => NULL, ], ], 'PartitionErrors' => [ 'base' => NULL, 'refs' => [ 'BatchCreatePartitionResponse$Errors' => 'The errors encountered when trying to create the requested partitions.
', 'BatchDeletePartitionResponse$Errors' => 'The errors encountered when trying to delete the requested partitions.
', ], ], 'PartitionIndex' => [ 'base' => 'A structure for a partition index.
', 'refs' => [ 'CreatePartitionIndexRequest$PartitionIndex' => 'Specifies a PartitionIndex
structure to create a partition index in an existing table.
A descriptor for a partition index in a table.
', 'refs' => [ 'PartitionIndexDescriptorList$member' => NULL, ], ], 'PartitionIndexDescriptorList' => [ 'base' => NULL, 'refs' => [ 'GetPartitionIndexesResponse$PartitionIndexDescriptorList' => 'A list of index descriptors.
', ], ], 'PartitionIndexList' => [ 'base' => NULL, 'refs' => [ 'CreateTableRequest$PartitionIndexes' => 'A list of partition indexes, PartitionIndex
structures, to create in the table.
The status of the partition index.
The possible statuses are:
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
ACTIVE: The index creation succeeds.
FAILED: The index creation fails.
DELETING: The index is deleted from the list of indexes.
The structure used to create and update a partition.
', 'refs' => [ 'BatchUpdatePartitionRequestEntry$PartitionInput' => 'The structure used to update a partition.
', 'CreatePartitionRequest$PartitionInput' => 'A PartitionInput
structure defining the partition to be created.
The new partition object to update the partition to.
The Values
property can\'t be changed. If you want to change the partition key values for a partition, delete and recreate the partition.
A list of PartitionInput
structures that define the partitions to be created.
A list of the requested partitions.
', 'GetPartitionsResponse$Partitions' => 'A list of requested partitions.
', ], ], 'PartitionValueList' => [ 'base' => 'Contains a list of values defining partitions.
', 'refs' => [ 'BackfillErroredPartitionsList$member' => NULL, 'BatchDeletePartitionValueList$member' => NULL, 'BatchGetPartitionValueList$member' => NULL, ], ], 'Path' => [ 'base' => NULL, 'refs' => [ 'DynamoDBTarget$Path' => 'The name of the DynamoDB table to crawl.
', 'JdbcTarget$Path' => 'The path of the JDBC target.
', 'MongoDBTarget$Path' => 'The path of the Amazon DocumentDB or MongoDB target (database/collection).
', 'PathList$member' => NULL, 'S3Target$Path' => 'The path to the Amazon S3 target.
', ], ], 'PathList' => [ 'base' => NULL, 'refs' => [ 'DeltaTarget$DeltaTables' => 'A list of the Amazon S3 paths to the Delta tables.
', 'HudiTarget$Paths' => 'An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
', 'HudiTarget$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'IcebergTarget$Paths' => 'One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix
.
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'JdbcTarget$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', 'S3Target$Exclusions' => 'A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
', ], ], 'Permission' => [ 'base' => NULL, 'refs' => [ 'PermissionList$member' => NULL, ], ], 'PermissionList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredTableMetadataRequest$Permissions' => 'The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
', 'GetUnfilteredTableMetadataResponse$Permissions' => 'The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
', 'PrincipalPermissions$Permissions' => 'The permissions that are granted to the principal.
', ], ], 'PermissionType' => [ 'base' => NULL, 'refs' => [ 'PermissionTypeList$member' => NULL, ], ], 'PermissionTypeList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$SupportedPermissionTypes' => '(Required) A list of supported permission types.
', 'GetUnfilteredPartitionsMetadataRequest$SupportedPermissionTypes' => 'A list of supported permission types.
', 'GetUnfilteredTableMetadataRequest$SupportedPermissionTypes' => 'Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the GetUnfilteredTableMetadata
API operation. Accepted values are:
COLUMN_PERMISSION
- Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns.
CELL_FILTER_PERMISSION
- Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table.
NESTED_PERMISSION
- Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions.
NESTED_CELL_PERMISSION
- Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.
Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.
Important: If you provide a supported permission type that doesn\'t match the user\'s level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the GetUnfilteredTableMetadata
operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.
The operation timed out.
', 'refs' => [], ], 'PhysicalConnectionRequirements' => [ 'base' => 'The OAuth client app in GetConnection response.
', 'refs' => [ 'Connection$PhysicalConnectionRequirements' => 'The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to make this connection successfully.
The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to successfully make this connection.
Indicates the type of PIIDetection transform.
', ], ], 'PolicyJsonString' => [ 'base' => NULL, 'refs' => [ 'GetResourcePolicyResponse$PolicyInJson' => 'Contains the requested policy document, in JSON format.
', 'GluePolicy$PolicyInJson' => 'Contains the requested policy document, in JSON format.
', 'PutResourcePolicyRequest$PolicyInJson' => 'Contains the policy document to set, in JSON format.
', ], ], 'PollingTime' => [ 'base' => NULL, 'refs' => [ 'StreamingDataPreviewOptions$PollingTime' => 'The polling time in milliseconds.
', ], ], 'PositiveInteger' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$NumberOfWorkers' => 'The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
', ], ], 'PositiveLong' => [ 'base' => NULL, 'refs' => [ 'StreamingDataPreviewOptions$RecordPollingLimit' => 'The limit to the number of records polled.
', ], ], 'PostgreSQLCatalogSource' => [ 'base' => 'Specifies a PostgresSQL data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$PostgreSQLCatalogSource' => 'Specifies a PostgresSQL data source in the Glue Data Catalog.
', ], ], 'PostgreSQLCatalogTarget' => [ 'base' => 'Specifies a target that uses Postgres SQL.
', 'refs' => [ 'CodeGenConfigurationNode$PostgreSQLCatalogTarget' => 'Specifies a target that uses Postgres SQL.
', ], ], 'Predecessor' => [ 'base' => 'A job run that was used in the predicate of a conditional trigger that triggered this job run.
', 'refs' => [ 'PredecessorList$member' => NULL, ], ], 'PredecessorList' => [ 'base' => NULL, 'refs' => [ 'JobRun$PredecessorRuns' => 'A list of predecessors to this job run.
', ], ], 'Predicate' => [ 'base' => 'Defines the predicate of the trigger, which determines when it fires.
', 'refs' => [ 'CreateTriggerRequest$Predicate' => 'A predicate to specify when the new trigger should fire.
This field is required when the trigger type is CONDITIONAL
.
The predicate of this trigger, which defines when it will fire.
', 'TriggerUpdate$Predicate' => 'The predicate of this trigger, which defines when it will fire.
', ], ], 'PredicateString' => [ 'base' => NULL, 'refs' => [ 'ColumnRowFilter$RowFilterExpression' => 'A string containing the row-level filter expression.
', 'GetPartitionsRequest$Expression' => 'An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE
filter clause. The SQL statement parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression
API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume \'variable a\' holds 10 and \'variable b\' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the partitionKey
type is created as a STRING
, to be compatible with the catalog partitions.
Sample API Call:
', 'GetUnfilteredPartitionsMetadataRequest$Expression' => 'An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE
filter clause. The SQL statement parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression
API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume \'variable a\' holds 10 and \'variable b\' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
', 'GetUnfilteredTableMetadataResponse$RowFilter' => 'The filter that applies to the table. For example when applying the filter in SQL, it would go in the WHERE
clause and can be evaluated by using an AND
operator with any other predicates applied by the user querying the table.
Permissions granted to a principal.
', 'refs' => [ 'PrincipalPermissionsList$member' => NULL, ], ], 'PrincipalPermissionsList' => [ 'base' => NULL, 'refs' => [ 'Database$CreateTableDefaultPermissions' => 'Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
', 'DatabaseInput$CreateTableDefaultPermissions' => 'Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'UserDefinedFunction$OwnerType' => 'The owner type.
', 'UserDefinedFunctionInput$OwnerType' => 'The owner type.
', ], ], 'Prob' => [ 'base' => NULL, 'refs' => [ 'Spigot$Prob' => 'The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
', ], ], 'ProfileConfiguration' => [ 'base' => 'Specifies the job and session values that an admin configures in an Glue usage profile.
', 'refs' => [ 'CreateUsageProfileRequest$Configuration' => 'A ProfileConfiguration
object specifying the job and session values for the profile.
A ProfileConfiguration
object specifying the job and session values for the profile.
A ProfileConfiguration
object specifying the job and session values for the profile.
Defines a property predicate.
', 'refs' => [ 'SearchPropertyPredicates$member' => NULL, ], ], 'PublicKeysList' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$PublicKeys' => 'A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint
API with the public key content in the deletePublicKeys
attribute, and the list of new keys in the addPublicKeys
attribute.
A list of public keys to be used by the DevEndpoints
for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.
If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint
API operation with the public key content in the deletePublicKeys
attribute, and the list of new keys in the addPublicKeys
attribute.
The list of public keys for the DevEndpoint
to use.
The list of public keys to be deleted from the DevEndpoint
.
The Python script generated from the DAG.
', 'GetDataflowGraphRequest$PythonScript' => 'The Python script to transform.
', 'GetPlanResponse$PythonScript' => 'A Python script to perform the mapping.
', ], ], 'PythonVersionString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$PythonVersion' => 'The Python version being used to run a Python shell job. Allowed values are 2 or 3.
', 'SessionCommand$PythonVersion' => 'Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
', ], ], 'QuerySchemaVersionMetadataInput' => [ 'base' => NULL, 'refs' => [], ], 'QuerySchemaVersionMetadataMaxResults' => [ 'base' => NULL, 'refs' => [ 'QuerySchemaVersionMetadataInput$MaxResults' => 'Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
', ], ], 'QuerySchemaVersionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'QuerySessionContext' => [ 'base' => 'A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request\'s authorization context.
', 'refs' => [ 'GetUnfilteredPartitionMetadataRequest$QuerySessionContext' => 'A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request\'s authorization context.
', 'GetUnfilteredPartitionsMetadataRequest$QuerySessionContext' => 'A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request\'s authorization context.
', 'GetUnfilteredTableMetadataRequest$QuerySessionContext' => 'A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request\'s authorization context.
', ], ], 'QuoteChar' => [ 'base' => NULL, 'refs' => [ 'S3CsvSource$QuoteChar' => 'Specifies the character to use for quoting. The default is a double quote: \'"\'
. Set this to -1
to turn off quoting entirely.
A Glue Studio node that uses a Glue DataBrew recipe in Glue jobs.
', 'refs' => [ 'CodeGenConfigurationNode$Recipe' => 'Specifies a Glue DataBrew recipe node.
', ], ], 'RecipeReference' => [ 'base' => 'A reference to a Glue DataBrew recipe.
', 'refs' => [ 'Recipe$RecipeReference' => 'A reference to the DataBrew recipe used by the node.
', ], ], 'RecipeVersion' => [ 'base' => NULL, 'refs' => [ 'RecipeReference$RecipeVersion' => 'The RecipeVersion of the DataBrew recipe.
', ], ], 'RecordsCount' => [ 'base' => NULL, 'refs' => [ 'ConfusionMatrix$NumTruePositives' => 'The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumFalsePositives' => 'The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumTrueNegatives' => 'The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
', 'ConfusionMatrix$NumFalseNegatives' => 'The number of matches in the data that the transform didn\'t find, in the confusion matrix for your transform.
', ], ], 'RecrawlBehavior' => [ 'base' => NULL, 'refs' => [ 'RecrawlPolicy$RecrawlBehavior' => 'Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of CRAWL_EVERYTHING
specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY
specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE
specifies crawling only the changes identified by Amazon S3 events.
When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in Glue in the developer guide.
', 'refs' => [ 'Crawler$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', 'CreateCrawlerRequest$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', 'UpdateCrawlerRequest$RecrawlPolicy' => 'A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
', ], ], 'RedirectUri' => [ 'base' => NULL, 'refs' => [ 'AuthorizationCodeProperties$RedirectUri' => 'The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.
', ], ], 'RedshiftSource' => [ 'base' => 'Specifies an Amazon Redshift data store.
', 'refs' => [ 'CodeGenConfigurationNode$RedshiftSource' => 'Specifies an Amazon Redshift data store.
', ], ], 'RedshiftTarget' => [ 'base' => 'Specifies a target that uses Amazon Redshift.
', 'refs' => [ 'CodeGenConfigurationNode$RedshiftTarget' => 'Specifies a target that uses Amazon Redshift.
', ], ], 'RegisterSchemaVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'RegisterSchemaVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegistryId' => [ 'base' => 'A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'refs' => [ 'CreateSchemaInput$RegistryId' => ' This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id
.
This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'GetRegistryInput$RegistryId' => 'This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'ListSchemasInput$RegistryId' => 'A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', 'UpdateRegistryInput$RegistryId' => 'This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
', ], ], 'RegistryListDefinition' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesResponse$Registries' => 'An array of RegistryDetailedListItem
objects containing minimal details of each registry.
A structure containing the details for a registry.
', 'refs' => [ 'RegistryListDefinition$member' => NULL, ], ], 'RegistryStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteRegistryResponse$Status' => 'The status of the registry. A successful operation will return the Deleting
status.
The status of the registry.
', 'RegistryListItem$Status' => 'The status of the registry.
', ], ], 'RelationalCatalogSource' => [ 'base' => 'Specifies a Relational database data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$RelationalCatalogSource' => 'Specifies a relational catalog data store in the Glue Data Catalog.
', ], ], 'RemoveSchemaVersionMetadataInput' => [ 'base' => NULL, 'refs' => [], ], 'RemoveSchemaVersionMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenameField' => [ 'base' => 'Specifies a transform that renames a single data property key.
', 'refs' => [ 'CodeGenConfigurationNode$RenameField' => 'Specifies a transform that renames a single data property key.
', ], ], 'ReplaceBoolean' => [ 'base' => NULL, 'refs' => [ 'ImportLabelsTaskRunProperties$Replace' => 'Indicates whether to overwrite your existing labels.
', 'StartImportLabelsTaskRunRequest$ReplaceAllLabels' => 'Indicates whether to overwrite your existing labels.
', ], ], 'ResetJobBookmarkRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetJobBookmarkResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotReadyException' => [ 'base' => 'A resource was not ready for a transaction.
', 'refs' => [], ], 'ResourceNumberLimitExceededException' => [ 'base' => 'A resource numerical limit was exceeded.
', 'refs' => [], ], 'ResourceShareType' => [ 'base' => NULL, 'refs' => [ 'GetDatabasesRequest$ResourceShareType' => 'Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED
, FOREIGN
or ALL
.
If set to FEDERATED
, will list the federated databases (referencing an external entity) shared with your account.
If set to FOREIGN
, will list the databases shared with your account.
If set to ALL
, will list the databases shared with your account, as well as the databases in yor local account.
Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN
or ALL
.
If set to FOREIGN
, will search the tables shared with your account.
If set to ALL
, will search the tables shared with your account, as well as the tables in yor local account.
The type of the resource.
', ], ], 'ResourceUri' => [ 'base' => 'The URIs for function resources.
', 'refs' => [ 'ResourceUriList$member' => NULL, ], ], 'ResourceUriList' => [ 'base' => NULL, 'refs' => [ 'UserDefinedFunction$ResourceUris' => 'The resource URIs for the function.
', 'UserDefinedFunctionInput$ResourceUris' => 'The resource URIs for the function.
', ], ], 'ResumeWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResumeWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$Role' => 'The IAM role that the service assumes to generate statistics.
', 'Crawler$Role' => 'The Amazon Resource Name (ARN) of an IAM role that\'s used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
', 'CreateCrawlerRequest$Role' => 'The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
', 'UpdateCrawlerRequest$Role' => 'The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$RoleArn' => 'The IAM role for the DevEndpoint
.
The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint
.
The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint
.
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
', 'CreateMLTransformRequest$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
An IAM role supplied to encrypt the results of the run.
', 'GetDataQualityRulesetEvaluationRunResponse$Role' => 'An IAM role supplied to encrypt the results of the run.
', 'GetMLTransformResponse$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
', 'Job$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
', 'JobUpdate$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
', 'MLTransform$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
An IAM role supplied to encrypt the results of the run.
', 'StartDataQualityRulesetEvaluationRunRequest$Role' => 'An IAM role supplied to encrypt the results of the run.
', 'UpdateMLTransformRequest$Role' => 'The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
', ], ], 'RowTag' => [ 'base' => NULL, 'refs' => [ 'CreateXMLClassifierRequest$RowTag' => 'The XML tag designating the element that contains each record in an XML document being parsed. This can\'t identify a self-closing element (closed by />
). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row>
is okay, but <row item_a="A" item_b="B" />
is not).
The XML tag designating the element that contains each record in an XML document being parsed. This cannot identify a self-closing element (closed by />
). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row>
is okay, but <row item_a="A" item_b="B" />
is not).
The XML tag designating the element that contains each record in an XML document being parsed. This can\'t identify a self-closing element (closed by />
). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row>
is okay, but <row item_a="A" item_b="B" />
is not).
A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.
', 'StartDataQualityRulesetEvaluationRunRequest$RulesetNames' => 'A list of ruleset names.
', ], ], 'RunId' => [ 'base' => NULL, 'refs' => [ 'GetJobBookmarkRequest$RunId' => 'The unique run identifier associated with this job run.
', 'JobBookmarkEntry$PreviousRunId' => 'The unique run identifier associated with the previous job run.
', 'JobBookmarkEntry$RunId' => 'The run ID number.
', 'ResetJobBookmarkRequest$RunId' => 'The unique run identifier associated with this job run.
', ], ], 'RunMetrics' => [ 'base' => 'Metrics for the optimizer run.
', 'refs' => [ 'TableOptimizerRun$metrics' => 'A RunMetrics
object containing metrics for the optimizer run.
In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
', ], ], 'S3CatalogDeltaSource' => [ 'base' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogDeltaSource' => 'Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', ], ], 'S3CatalogHudiSource' => [ 'base' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog. The Hudi data source must be stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogHudiSource' => 'Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
', ], ], 'S3CatalogSource' => [ 'base' => 'Specifies an Amazon S3 data store in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogSource' => 'Specifies an Amazon S3 data store in the Glue Data Catalog.
', ], ], 'S3CatalogTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3CatalogTarget' => 'Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
', ], ], 'S3CsvSource' => [ 'base' => 'Specifies a command-separated value (CSV) data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3CsvSource' => 'Specifies a command-separated value (CSV) data store stored in Amazon S3.
', ], ], 'S3DeltaCatalogTarget' => [ 'base' => 'Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaCatalogTarget' => 'Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
', ], ], 'S3DeltaDirectTarget' => [ 'base' => 'Specifies a target that writes to a Delta Lake data source in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaDirectTarget' => 'Specifies a target that writes to a Delta Lake data source in Amazon S3.
', ], ], 'S3DeltaSource' => [ 'base' => 'Specifies a Delta Lake data source stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DeltaSource' => 'Specifies a Delta Lake data source stored in Amazon S3.
', ], ], 'S3DirectSourceAdditionalOptions' => [ 'base' => 'Specifies additional connection options for the Amazon S3 data store.
', 'refs' => [ 'S3CsvSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3DeltaSource$AdditionalOptions' => 'Specifies additional options for the connector.
', 'S3HudiSource$AdditionalOptions' => 'Specifies additional options for the connector.
', 'S3JsonSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3ParquetSource$AdditionalOptions' => 'Specifies additional connection options.
', ], ], 'S3DirectTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3DirectTarget' => 'Specifies a data target that writes to Amazon S3.
', ], ], 'S3Encryption' => [ 'base' => 'Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
', 'refs' => [ 'S3EncryptionList$member' => NULL, ], ], 'S3EncryptionList' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$S3Encryption' => 'The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
', ], ], 'S3EncryptionMode' => [ 'base' => NULL, 'refs' => [ 'S3Encryption$S3EncryptionMode' => 'The encryption mode to use for Amazon S3 data.
', ], ], 'S3GlueParquetTarget' => [ 'base' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', 'refs' => [ 'CodeGenConfigurationNode$S3GlueParquetTarget' => 'Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
', ], ], 'S3HudiCatalogTarget' => [ 'base' => 'Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiCatalogTarget' => 'Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
', ], ], 'S3HudiDirectTarget' => [ 'base' => 'Specifies a target that writes to a Hudi data source in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiDirectTarget' => 'Specifies a target that writes to a Hudi data source in Amazon S3.
', ], ], 'S3HudiSource' => [ 'base' => 'Specifies a Hudi data source stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3HudiSource' => 'Specifies a Hudi data source stored in Amazon S3.
', ], ], 'S3JsonSource' => [ 'base' => 'Specifies a JSON data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3JsonSource' => 'Specifies a JSON data store stored in Amazon S3.
', ], ], 'S3ParquetSource' => [ 'base' => 'Specifies an Apache Parquet data store stored in Amazon S3.
', 'refs' => [ 'CodeGenConfigurationNode$S3ParquetSource' => 'Specifies an Apache Parquet data store stored in Amazon S3.
', ], ], 'S3SourceAdditionalOptions' => [ 'base' => 'Specifies additional connection options for the Amazon S3 data store.
', 'refs' => [ 'GovernedCatalogSource$AdditionalOptions' => 'Specifies additional connection options.
', 'S3CatalogSource$AdditionalOptions' => 'Specifies additional connection options.
', ], ], 'S3Target' => [ 'base' => 'Specifies a data store in Amazon Simple Storage Service (Amazon S3).
', 'refs' => [ 'S3TargetList$member' => NULL, ], ], 'S3TargetList' => [ 'base' => NULL, 'refs' => [ 'CrawlerTargets$S3Targets' => 'Specifies Amazon Simple Storage Service (Amazon S3) targets.
', ], ], 'SampleSizePercentage' => [ 'base' => NULL, 'refs' => [ 'ColumnStatisticsTaskRun$SampleSize' => 'The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
', 'StartColumnStatisticsTaskRunRequest$SampleSize' => 'The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
', ], ], 'ScalaCode' => [ 'base' => NULL, 'refs' => [ 'CreateScriptResponse$ScalaCode' => 'The Scala code generated from the DAG.
', 'GetPlanResponse$ScalaCode' => 'The Scala code to perform the mapping.
', ], ], 'Schedule' => [ 'base' => 'A scheduling object using a cron
statement to schedule an event.
For scheduled crawlers, the schedule when the crawler runs.
', ], ], 'ScheduleState' => [ 'base' => NULL, 'refs' => [ 'Schedule$State' => 'The state of the schedule.
', ], ], 'SchedulerNotRunningException' => [ 'base' => 'The specified scheduler is not running.
', 'refs' => [], ], 'SchedulerRunningException' => [ 'base' => 'The specified scheduler is already running.
', 'refs' => [], ], 'SchedulerTransitioningException' => [ 'base' => 'The specified scheduler is transitioning.
', 'refs' => [], ], 'SchemaChangePolicy' => [ 'base' => 'A policy that specifies update and deletion behaviors for the crawler.
', 'refs' => [ 'Crawler$SchemaChangePolicy' => 'The policy that specifies update and delete behaviors for the crawler.
', 'CreateCrawlerRequest$SchemaChangePolicy' => 'The policy for the crawler\'s update and deletion behavior.
', 'UpdateCrawlerRequest$SchemaChangePolicy' => 'The policy for the crawler\'s update and deletion behavior.
', ], ], 'SchemaCheckpointNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$SchemaCheckpoint' => 'The version number of the checkpoint (the last time the compatibility mode was changed).
', 'GetSchemaResponse$SchemaCheckpoint' => 'The version number of the checkpoint (the last time the compatibility mode was changed).
', ], ], 'SchemaColumn' => [ 'base' => 'A key-value pair representing a column and data type that this transform can run against. The Schema
parameter of the MLTransform
may contain up to 100 of these structures.
The difference between schemas as a string in JsonPatch format.
', ], ], 'SchemaDefinitionString' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityInput$SchemaDefinition' => 'The definition of the schema that has to be validated.
', 'CreateSchemaInput$SchemaDefinition' => 'The schema definition using the DataFormat
setting for SchemaName
.
The definition of the schema for which schema details are required.
', 'GetSchemaVersionResponse$SchemaDefinition' => 'The schema definition for the schema ID.
', 'RegisterSchemaVersionInput$SchemaDefinition' => 'The schema definition using the DataFormat
setting for the SchemaName
.
Refers to SYNTAX_DIFF
, which is the currently supported diff type.
The unique ID of the schema in the Glue schema registry.
', 'refs' => [ 'DeleteSchemaInput$SchemaId' => 'This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'DeleteSchemaVersionsInput$SchemaId' => 'This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'GetSchemaByDefinitionInput$SchemaId' => 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn
or SchemaName
has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn
or SchemaName
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn
or SchemaName
has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn
or SchemaName
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
The unique ID for the schema.
', 'QuerySchemaVersionMetadataInput$SchemaId' => 'A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'RegisterSchemaVersionInput$SchemaId' => 'This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn
or SchemaName
and RegistryName
has to be provided.
A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
', 'SchemaReference$SchemaId' => 'A structure that contains schema identity fields. Either this or the SchemaVersionId
has to be provided.
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn
or SchemaName
has to be provided.
SchemaId$SchemaName: The name of the schema. One of SchemaArn
or SchemaName
has to be provided.
An array of SchemaListItem
objects containing details of each schema.
An object that contains minimal details for a schema.
', 'refs' => [ 'SchemaListDefinition$member' => NULL, ], ], 'SchemaPathString' => [ 'base' => NULL, 'refs' => [ 'MappingEntry$SourcePath' => 'The source path.
', 'MappingEntry$TargetPath' => 'The target path.
', ], ], 'SchemaReference' => [ 'base' => 'An object that references a schema stored in the Glue Schema Registry.
', 'refs' => [ 'StorageDescriptor$SchemaReference' => 'An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
', ], ], 'SchemaRegistryNameString' => [ 'base' => NULL, 'refs' => [ 'CreateRegistryInput$RegistryName' => 'Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
', 'CreateRegistryResponse$RegistryName' => 'The name of the registry.
', 'CreateSchemaInput$SchemaName' => 'Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
', 'CreateSchemaResponse$RegistryName' => 'The name of the registry.
', 'CreateSchemaResponse$SchemaName' => 'The name of the schema.
', 'DeleteRegistryResponse$RegistryName' => 'The name of the registry being deleted.
', 'DeleteSchemaResponse$SchemaName' => 'The name of the schema being deleted.
', 'GetRegistryResponse$RegistryName' => 'The name of the registry.
', 'GetSchemaResponse$RegistryName' => 'The name of the registry.
', 'GetSchemaResponse$SchemaName' => 'The name of the schema.
', 'PutSchemaVersionMetadataResponse$SchemaName' => 'The name for the schema.
', 'PutSchemaVersionMetadataResponse$RegistryName' => 'The name for the registry.
', 'RegistryId$RegistryName' => 'Name of the registry. Used only for lookup. One of RegistryArn
or RegistryName
has to be provided.
The name of the registry.
', 'RemoveSchemaVersionMetadataResponse$SchemaName' => 'The name of the schema.
', 'RemoveSchemaVersionMetadataResponse$RegistryName' => 'The name of the registry.
', 'SchemaId$SchemaName' => 'The name of the schema. One of SchemaArn
or SchemaName
has to be provided.
The name of the schema registry that contains the schema.
', 'SchemaListItem$RegistryName' => 'the name of the registry where the schema resides.
', 'SchemaListItem$SchemaName' => 'The name of the schema.
', 'UpdateRegistryResponse$RegistryName' => 'The name of the updated registry.
', 'UpdateSchemaResponse$SchemaName' => 'The name of the schema.
', 'UpdateSchemaResponse$RegistryName' => 'The name of the registry that contains the schema.
', ], ], 'SchemaRegistryTokenString' => [ 'base' => NULL, 'refs' => [ 'ListRegistriesInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListRegistriesResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'ListSchemaVersionsInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListSchemaVersionsResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'ListSchemasInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListSchemasResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'QuerySchemaVersionMetadataInput$NextToken' => 'A continuation token, if this is a continuation call.
', 'QuerySchemaVersionMetadataResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', ], ], 'SchemaStatus' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$SchemaStatus' => 'The status of the schema.
', 'DeleteSchemaResponse$Status' => 'The status of the schema.
', 'GetSchemaResponse$SchemaStatus' => 'The status of the schema.
', 'SchemaListItem$SchemaStatus' => 'The status of the schema.
', ], ], 'SchemaValidationError' => [ 'base' => NULL, 'refs' => [ 'CheckSchemaVersionValidityResponse$Error' => 'A validation failure error message.
', ], ], 'SchemaVersionErrorItem' => [ 'base' => 'An object that contains the error details for an operation on a schema version.
', 'refs' => [ 'SchemaVersionErrorList$member' => NULL, ], ], 'SchemaVersionErrorList' => [ 'base' => NULL, 'refs' => [ 'DeleteSchemaVersionsResponse$SchemaVersionErrors' => 'A list of SchemaVersionErrorItem
objects, each containing an error and schema version.
The unique identifier of the first schema version.
', 'GetSchemaByDefinitionResponse$SchemaVersionId' => 'The schema ID of the schema version.
', 'GetSchemaVersionInput$SchemaVersionId' => 'The SchemaVersionId
of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId
wrapper has to be provided.
The SchemaVersionId
of the schema version.
The unique version ID of the schema version.
', 'PutSchemaVersionMetadataResponse$SchemaVersionId' => 'The unique version ID of the schema version.
', 'QuerySchemaVersionMetadataInput$SchemaVersionId' => 'The unique version ID of the schema version.
', 'QuerySchemaVersionMetadataResponse$SchemaVersionId' => 'The unique version ID of the schema version.
', 'RegisterSchemaVersionResponse$SchemaVersionId' => 'The unique ID that represents the version of this schema.
', 'RemoveSchemaVersionMetadataInput$SchemaVersionId' => 'The unique version ID of the schema version.
', 'RemoveSchemaVersionMetadataResponse$SchemaVersionId' => 'The version ID for the schema version.
', 'SchemaReference$SchemaVersionId' => 'The unique ID assigned to a version of the schema. Either this or the SchemaId
has to be provided.
The unique identifier of the schema version.
', ], ], 'SchemaVersionList' => [ 'base' => NULL, 'refs' => [ 'ListSchemaVersionsResponse$Schemas' => 'An array of SchemaVersionList
objects containing details of each schema version.
An object containing the details about a schema version.
', 'refs' => [ 'SchemaVersionList$member' => NULL, ], ], 'SchemaVersionNumber' => [ 'base' => 'A structure containing the schema version information.
', 'refs' => [ 'GetSchemaVersionInput$SchemaVersionNumber' => 'The version number of the schema.
', 'GetSchemaVersionsDiffInput$FirstSchemaVersionNumber' => 'The first of the two schema versions to be compared.
', 'GetSchemaVersionsDiffInput$SecondSchemaVersionNumber' => 'The second of the two schema versions to be compared.
', 'PutSchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'QuerySchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'RemoveSchemaVersionMetadataInput$SchemaVersionNumber' => 'The version number of the schema.
', 'UpdateSchemaInput$SchemaVersionNumber' => 'Version number required for check pointing. One of VersionNumber
or Compatibility
has to be provided.
The status of the first schema version created.
', 'GetSchemaByDefinitionResponse$Status' => 'The status of the schema version.
', 'GetSchemaVersionResponse$Status' => 'The status of the schema version.
', 'RegisterSchemaVersionResponse$Status' => 'The status of the schema version.
', 'SchemaVersionListItem$Status' => 'The status of the schema version.
', ], ], 'ScriptLocationString' => [ 'base' => NULL, 'refs' => [ 'JobCommand$ScriptLocation' => 'Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
', ], ], 'SearchPropertyPredicates' => [ 'base' => NULL, 'refs' => [ 'SearchTablesRequest$Filters' => 'A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator
member of the PropertyPredicate
struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name
, a fuzzy match algorithm is used. The Key
field (for example, the value of the Name
field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value
member of PropertyPredicate
. For example, if Key=Name
and Value=link
, tables named customer-link
and xx-link-yy
are returned, but xxlinkyy
is not returned.
The secret manager ARN to store credentials.
', 'AuthenticationConfigurationInput$SecretArn' => 'The secret manager ARN to store credentials in the CreateConnection request.
', ], ], 'SecurityConfiguration' => [ 'base' => 'Specifies a security configuration.
', 'refs' => [ 'GetSecurityConfigurationResponse$SecurityConfiguration' => 'The requested security configuration.
', 'SecurityConfigurationList$member' => NULL, ], ], 'SecurityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'GetSecurityConfigurationsResponse$SecurityConfigurations' => 'A list of security configurations.
', ], ], 'SecurityGroupIdList' => [ 'base' => NULL, 'refs' => [ 'PhysicalConnectionRequirements$SecurityGroupIdList' => 'The security group ID list used by the connection.
', ], ], 'Segment' => [ 'base' => 'Defines a non-overlapping region of a table\'s partitions, allowing multiple requests to be run in parallel.
', 'refs' => [ 'GetPartitionsRequest$Segment' => 'The segment of the table\'s partitions to scan in this request.
', 'GetUnfilteredPartitionsMetadataRequest$Segment' => 'The segment of the table\'s partitions to scan in this request.
', ], ], 'SelectFields' => [ 'base' => 'Specifies a transform that chooses the data property keys that you want to keep.
', 'refs' => [ 'CodeGenConfigurationNode$SelectFields' => 'Specifies a transform that chooses the data property keys that you want to keep.
', ], ], 'SelectFromCollection' => [ 'base' => 'Specifies a transform that chooses one DynamicFrame
from a collection of DynamicFrames
. The output is the selected DynamicFrame
Specifies a transform that chooses one DynamicFrame
from a collection of DynamicFrames
. The output is the selected DynamicFrame
Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
', ], ], 'SerDeInfo' => [ 'base' => 'Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
', 'refs' => [ 'StorageDescriptor$SerdeInfo' => 'The serialization/deserialization (SerDe) information.
', ], ], 'Session' => [ 'base' => 'The period in which a remote Spark runtime environment is running.
', 'refs' => [ 'CreateSessionResponse$Session' => 'Returns the session object in the response.
', 'GetSessionResponse$Session' => 'The session object is returned in the response.
', 'SessionList$member' => NULL, ], ], 'SessionCommand' => [ 'base' => 'The SessionCommand
that runs the job.
The SessionCommand
that runs the job.
The command object.See SessionCommand.
', ], ], 'SessionIdList' => [ 'base' => NULL, 'refs' => [ 'ListSessionsResponse$Ids' => 'Returns the ID of the session.
', ], ], 'SessionList' => [ 'base' => NULL, 'refs' => [ 'ListSessionsResponse$Sessions' => 'Returns the session object.
', ], ], 'SessionStatus' => [ 'base' => NULL, 'refs' => [ 'Session$Status' => 'The session status.
', ], ], 'SkewedInfo' => [ 'base' => 'Specifies skewed values in a table. Skewed values are those that occur with very high frequency.
', 'refs' => [ 'StorageDescriptor$SkewedInfo' => 'The information about values that appear frequently in a column (skewed values).
', ], ], 'SnowflakeNodeData' => [ 'base' => 'Specifies configuration for Snowflake nodes in Glue Studio.
', 'refs' => [ 'SnowflakeSource$Data' => 'Configuration for the Snowflake data source.
', 'SnowflakeTarget$Data' => 'Specifies the data of the Snowflake target node.
', ], ], 'SnowflakeSource' => [ 'base' => 'Specifies a Snowflake data source.
', 'refs' => [ 'CodeGenConfigurationNode$SnowflakeSource' => 'Specifies a Snowflake data source.
', ], ], 'SnowflakeTarget' => [ 'base' => 'Specifies a Snowflake target.
', 'refs' => [ 'CodeGenConfigurationNode$SnowflakeTarget' => 'Specifies a target that writes to a Snowflake data source.
', ], ], 'Sort' => [ 'base' => NULL, 'refs' => [ 'SortCriterion$Sort' => 'An ascending or descending sort.
', ], ], 'SortCriteria' => [ 'base' => NULL, 'refs' => [ 'SearchTablesRequest$SortCriteria' => 'A list of criteria for sorting the results by a field name, in an ascending or descending order.
', ], ], 'SortCriterion' => [ 'base' => 'Specifies a field to sort by and a sort order.
', 'refs' => [ 'SortCriteria$member' => NULL, ], ], 'SortDirectionType' => [ 'base' => NULL, 'refs' => [ 'TaskRunSortCriteria$SortDirection' => 'The sort direction to be used to sort the list of task runs for the machine learning transform.
', 'TransformSortCriteria$SortDirection' => 'The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
', ], ], 'SourceControlAuthStrategy' => [ 'base' => NULL, 'refs' => [ 'SourceControlDetails$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', 'UpdateJobFromSourceControlRequest$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', 'UpdateSourceControlFromJobRequest$AuthStrategy' => 'The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
', ], ], 'SourceControlDetails' => [ 'base' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'refs' => [ 'CreateJobRequest$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'Job$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', 'JobUpdate$SourceControlDetails' => 'The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
', ], ], 'SourceControlProvider' => [ 'base' => NULL, 'refs' => [ 'SourceControlDetails$Provider' => 'The provider for the remote repository.
', 'UpdateJobFromSourceControlRequest$Provider' => 'The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.
', 'UpdateSourceControlFromJobRequest$Provider' => 'The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.
', ], ], 'SparkConnectorSource' => [ 'base' => 'Specifies a connector to an Apache Spark data source.
', 'refs' => [ 'CodeGenConfigurationNode$SparkConnectorSource' => 'Specifies a connector to an Apache Spark data source.
', ], ], 'SparkConnectorTarget' => [ 'base' => 'Specifies a target that uses an Apache Spark connector.
', 'refs' => [ 'CodeGenConfigurationNode$SparkConnectorTarget' => 'Specifies a target that uses an Apache Spark connector.
', ], ], 'SparkSQL' => [ 'base' => 'Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame
.
Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame
.
Specifies a transform that writes samples of the data to an Amazon S3 bucket.
', 'refs' => [ 'CodeGenConfigurationNode$Spigot' => 'Specifies a transform that writes samples of the data to an Amazon S3 bucket.
', ], ], 'SplitFields' => [ 'base' => 'Specifies a transform that splits data property keys into two DynamicFrames
. The output is a collection of DynamicFrames
: one with selected data property keys, and one with the remaining data property keys.
Specifies a transform that splits data property keys into two DynamicFrames
. The output is a collection of DynamicFrames
: one with selected data property keys, and one with the remaining data property keys.
Represents a single entry in the list of values for SqlAliases
.
A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify From
as MyDataSource, and Alias
as SqlName, then in your SQL you can do:
select * from SqlName
and that gets data from MyDataSource.
', ], ], 'SqlQuery' => [ 'base' => NULL, 'refs' => [ 'JDBCConnectorSource$Query' => 'The table or SQL query to get the data from. You can specify either ConnectionTable
or query
, but not both.
A SQL query that must use Spark SQL syntax and return a single data set.
', ], ], 'StartBlueprintRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartBlueprintRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartColumnStatisticsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartColumnStatisticsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRuleRecommendationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRuleRecommendationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRulesetEvaluationRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartDataQualityRulesetEvaluationRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartExportLabelsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartExportLabelsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartImportLabelsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartImportLabelsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartJobRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartJobRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMLEvaluationTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMLEvaluationTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartMLLabelingSetGenerationTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMLLabelingSetGenerationTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartingEventBatchCondition' => [ 'base' => 'The batch condition that started the workflow run. Either the number of events in the batch size arrived, in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow member is non-zero.
', 'refs' => [ 'WorkflowRun$StartingEventBatchCondition' => 'The batch condition that started the workflow run.
', ], ], 'StartingPosition' => [ 'base' => NULL, 'refs' => [ 'KinesisStreamingSourceOptions$StartingPosition' => 'The starting position in the Kinesis data stream to read data from. The possible values are "latest"
, "trim_horizon"
, "earliest"
, or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ
(where Z
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest"
.
Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
', ], ], 'Statement' => [ 'base' => 'The statement or request for a particular action to occur in a session.
', 'refs' => [ 'GetStatementResponse$Statement' => 'Returns the statement.
', 'StatementList$member' => NULL, ], ], 'StatementList' => [ 'base' => NULL, 'refs' => [ 'ListStatementsResponse$Statements' => 'Returns the list of statements.
', ], ], 'StatementOutput' => [ 'base' => 'The code execution output in JSON format.
', 'refs' => [ 'Statement$Output' => 'The output in JSON.
', ], ], 'StatementOutputData' => [ 'base' => 'The code execution output in JSON format.
', 'refs' => [ 'StatementOutput$Data' => 'The code execution output.
', ], ], 'StatementState' => [ 'base' => NULL, 'refs' => [ 'Statement$State' => 'The state while request is actioned.
', 'StatementOutput$Status' => 'The status of the code execution output.
', ], ], 'StopColumnStatisticsTaskRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopColumnStatisticsTaskRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopTriggerRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopTriggerResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkflowRunRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkflowRunResponse' => [ 'base' => NULL, 'refs' => [], ], 'StorageDescriptor' => [ 'base' => 'Describes the physical storage of table data.
', 'refs' => [ 'Partition$StorageDescriptor' => 'Provides information about the physical location where the partition is stored.
', 'PartitionInput$StorageDescriptor' => 'Provides information about the physical location where the partition is stored.
', 'Table$StorageDescriptor' => 'A storage descriptor containing information about the physical storage of this table.
', 'TableInput$StorageDescriptor' => 'A storage descriptor containing information about the physical storage of this table.
', ], ], 'StreamingDataPreviewOptions' => [ 'base' => 'Specifies options related to data preview for viewing a sample of your data.
', 'refs' => [ 'CatalogKafkaSource$DataPreviewOptions' => 'Specifies options related to data preview for viewing a sample of your data.
', 'CatalogKinesisSource$DataPreviewOptions' => 'Additional options for data preview.
', 'DirectKafkaSource$DataPreviewOptions' => 'Specifies options related to data preview for viewing a sample of your data.
', 'DirectKinesisSource$DataPreviewOptions' => 'Additional options for data preview.
', ], ], 'StringColumnStatisticsData' => [ 'base' => 'Defines column statistics supported for character sequence data values.
', 'refs' => [ 'ColumnStatisticsData$StringColumnStatisticsData' => 'String column statistics data.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$SecurityGroupIds' => 'Security group IDs for the security groups to be used by the new DevEndpoint
.
The security groups assigned to the new DevEndpoint
.
A list of security group identifiers used in this DevEndpoint
.
The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint
.
A structure specifying the dialect and dialect version used by the query engine.
', 'refs' => [ 'GetUnfilteredTableMetadataRequest$SupportedDialect' => 'A structure specifying the dialect and dialect version used by the query engine.
', ], ], 'Table' => [ 'base' => 'Represents a collection of related data organized in columns and rows.
', 'refs' => [ 'GetTableResponse$Table' => 'The Table
object that defines the specified table.
A Table object containing the table metadata.
', 'TableList$member' => NULL, 'TableVersion$Table' => 'The table in question.
', ], ], 'TableError' => [ 'base' => 'An error record for table operations.
', 'refs' => [ 'TableErrors$member' => NULL, ], ], 'TableErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableResponse$Errors' => 'A list of errors encountered in attempting to delete the specified tables.
', ], ], 'TableIdentifier' => [ 'base' => 'A structure that describes a target table for resource linking.
', 'refs' => [ 'Table$TargetTable' => 'A TableIdentifier
structure that describes a target table for resource linking.
A TableIdentifier
structure that describes a target table for resource linking.
A structure used to define a table.
', 'refs' => [ 'CreateTableRequest$TableInput' => 'The TableInput
object that defines the metadata table to create in the catalog.
An updated TableInput
object to define the metadata table in the catalog.
A list of the requested Table
objects.
A list of the requested Table
objects. The SearchTables
response returns only the tables that you have access to.
The name of the table for which column statistics is generated.
', 'MappingEntry$SourceTable' => 'The name of the source table.
', 'MappingEntry$TargetTable' => 'The target table.
', ], ], 'TableOptimizer' => [ 'base' => 'Contains details about an optimizer associated with a table.
', 'refs' => [ 'BatchTableOptimizer$tableOptimizer' => 'A TableOptimizer
object that contains details on the configuration and last run of a table optimzer.
The optimizer associated with the specified table.
', ], ], 'TableOptimizerConfiguration' => [ 'base' => 'Contains details on the configuration of a table optimizer. You pass this configuration when creating or updating a table optimizer.
', 'refs' => [ 'CreateTableOptimizerRequest$TableOptimizerConfiguration' => 'A TableOptimizerConfiguration
object representing the configuration of a table optimizer.
A TableOptimizerConfiguration
object that was specified when creating or updating a table optimizer.
A TableOptimizerConfiguration
object representing the configuration of a table optimizer.
An event type representing the status of the table optimizer run.
', ], ], 'TableOptimizerRun' => [ 'base' => 'Contains details for a table optimizer run.
', 'refs' => [ 'TableOptimizer$lastRun' => 'A TableOptimizerRun
object representing the last run of the table optimizer.
Represents the epoch timestamp at which the compaction job was started within Lake Formation.
', 'TableOptimizerRun$endTimestamp' => 'Represents the epoch timestamp at which the compaction job ended.
', ], ], 'TableOptimizerRuns' => [ 'base' => NULL, 'refs' => [ 'ListTableOptimizerRunsResponse$TableOptimizerRuns' => 'A list of the optimizer runs associated with a table.
', ], ], 'TableOptimizerType' => [ 'base' => NULL, 'refs' => [ 'BatchGetTableOptimizerEntry$type' => 'The type of table optimizer.
', 'BatchGetTableOptimizerError$type' => 'The type of table optimizer.
', 'CreateTableOptimizerRequest$Type' => 'The type of table optimizer. Currently, the only valid value is compaction
.
The type of table optimizer.
', 'GetTableOptimizerRequest$Type' => 'The type of table optimizer.
', 'ListTableOptimizerRunsRequest$Type' => 'The type of table optimizer. Currently, the only valid value is compaction
.
The type of table optimizer. Currently, the only valid value is compaction
.
The type of table optimizer. Currently, the only valid value is compaction
.
The prefix added to the names of tables that are created.
', 'CreateCrawlerRequest$TablePrefix' => 'The table prefix used for catalog tables that are created.
', 'UpdateCrawlerRequest$TablePrefix' => 'The table prefix used for catalog tables that are created.
', ], ], 'TableTypeString' => [ 'base' => NULL, 'refs' => [ 'Table$TableType' => 'The type of this table. Glue will create tables with the EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED
.
The type of this table. Glue will create tables with the EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED
.
Specifies a version of a table.
', 'refs' => [ 'GetTableVersionResponse$TableVersion' => 'The requested table version.
', 'GetTableVersionsList$member' => NULL, ], ], 'TableVersionError' => [ 'base' => 'An error record for table-version operations.
', 'refs' => [ 'TableVersionErrors$member' => NULL, ], ], 'TableVersionErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionResponse$Errors' => 'A list of errors encountered while trying to delete the specified table versions.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeysList$member' => NULL, 'TagsMap$key' => NULL, ], ], 'TagKeysList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagsToRemove' => 'Tags to remove from this resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagsMap$value' => NULL, ], ], 'TagsMap' => [ 'base' => NULL, 'refs' => [ 'CreateBlueprintRequest$Tags' => 'The tags to be applied to this blueprint.
', 'CreateConnectionRequest$Tags' => 'The tags you assign to the connection.
', 'CreateCrawlerRequest$Tags' => 'The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateCustomEntityTypeRequest$Tags' => 'A list of tags applied to the custom entity type.
', 'CreateDataQualityRulesetRequest$Tags' => 'A list of tags applied to the data quality ruleset.
', 'CreateDatabaseRequest$Tags' => 'The tags you assign to the database.
', 'CreateDevEndpointRequest$Tags' => 'The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateJobRequest$Tags' => 'The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateMLTransformRequest$Tags' => 'The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateRegistryInput$Tags' => 'Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
', 'CreateRegistryResponse$Tags' => 'The tags for the registry.
', 'CreateSchemaInput$Tags' => 'Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
', 'CreateSchemaResponse$Tags' => 'The tags for the schema.
', 'CreateSessionRequest$Tags' => 'The map of key value pairs (tags) belonging to the session.
', 'CreateTriggerRequest$Tags' => 'The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
', 'CreateUsageProfileRequest$Tags' => 'A list of tags applied to the usage profile.
', 'CreateWorkflowRequest$Tags' => 'The tags to be used with this workflow.
', 'GetTagsResponse$Tags' => 'The requested tags.
', 'ListBlueprintsRequest$Tags' => 'Filters the list by an Amazon Web Services resource tag.
', 'ListCrawlersRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListCustomEntityTypesRequest$Tags' => 'A list of key-value pair tags.
', 'ListDataQualityRulesetsRequest$Tags' => 'A list of key-value pair tags.
', 'ListDevEndpointsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListJobsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListMLTransformsRequest$Tags' => 'Specifies to return only these tagged resources.
', 'ListSessionsRequest$Tags' => 'Tags belonging to the session.
', 'ListTriggersRequest$Tags' => 'Specifies to return only these tagged resources.
', 'TagResourceRequest$TagsToAdd' => 'Tags to add to this resource.
', ], ], 'TargetFormat' => [ 'base' => NULL, 'refs' => [ 'S3DeltaDirectTarget$Format' => 'Specifies the data output format for the target.
', 'S3DirectTarget$Format' => 'Specifies the data output format for the target.
', 'S3HudiDirectTarget$Format' => 'Specifies the data output format for the target.
', ], ], 'TaskRun' => [ 'base' => 'The sampling parameters that are associated with the machine learning transform.
', 'refs' => [ 'TaskRunList$member' => NULL, ], ], 'TaskRunFilterCriteria' => [ 'base' => 'The criteria that are used to filter the task runs for the machine learning transform.
', 'refs' => [ 'GetMLTaskRunsRequest$Filter' => 'The filter criteria, in the TaskRunFilterCriteria
structure, for the task run.
A list of task runs that are associated with the transform.
', ], ], 'TaskRunProperties' => [ 'base' => 'The configuration properties for the task run.
', 'refs' => [ 'GetMLTaskRunResponse$Properties' => 'The list of properties that are associated with the task run.
', 'TaskRun$Properties' => 'Specifies configuration properties associated with this task run.
', ], ], 'TaskRunSortColumnType' => [ 'base' => NULL, 'refs' => [ 'TaskRunSortCriteria$Column' => 'The column to be used to sort the list of task runs for the machine learning transform.
', ], ], 'TaskRunSortCriteria' => [ 'base' => 'The sorting criteria that are used to sort the list of task runs for the machine learning transform.
', 'refs' => [ 'GetMLTaskRunsRequest$Sort' => 'The sorting criteria, in the TaskRunSortCriteria
structure, for the task run.
The status for this run.
', 'DataQualityRuleRecommendationRunDescription$Status' => 'The status for this run.
', 'DataQualityRulesetEvaluationRunDescription$Status' => 'The status for this run.
', 'GetDataQualityRuleRecommendationRunResponse$Status' => 'The status for this run.
', 'GetDataQualityRulesetEvaluationRunResponse$Status' => 'The status for this run.
', 'GetMLTaskRunResponse$Status' => 'The status for this task run.
', 'TaskRun$Status' => 'The current status of the requested task run.
', 'TaskRunFilterCriteria$Status' => 'The current status of the task run.
', ], ], 'TaskType' => [ 'base' => NULL, 'refs' => [ 'TaskRunFilterCriteria$TaskRunType' => 'The type of task run.
', 'TaskRunProperties$TaskType' => 'The type of task run.
', ], ], 'Timeout' => [ 'base' => NULL, 'refs' => [ 'Action$Timeout' => 'The JobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'CreateMLTransformRequest$Timeout' => 'The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation for other job types.
', 'CreateSessionRequest$IdleTimeout' => 'The number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types.
', 'GetDataQualityRuleRecommendationRunResponse$Timeout' => 'The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'JobRun$Timeout' => 'The JobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'JobUpdate$Timeout' => 'The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'MLTransform$Timeout' => 'The timeout in minutes of the machine learning transform.
', 'StartDataQualityRuleRecommendationRunRequest$Timeout' => 'The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The JobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
', 'UpdateMLTransformRequest$Timeout' => 'The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
The time that the migration was started.
', 'ColumnStatistics$AnalyzedTime' => 'The timestamp of when column statistics were generated.
', 'ColumnStatisticsTaskRun$CreationTime' => 'The time that this task was created.
', 'ColumnStatisticsTaskRun$LastUpdated' => 'The last point in time when this task was modified.
', 'ColumnStatisticsTaskRun$StartTime' => 'The start time of the task.
', 'ColumnStatisticsTaskRun$EndTime' => 'The end time of the task.
', 'Connection$CreationTime' => 'The timestamp of the time that this connection definition was created.
', 'Connection$LastUpdatedTime' => 'The timestamp of the last time the connection definition was updated.
', 'Connection$LastConnectionValidationTime' => 'A timestamp of the time this connection was last validated.
', 'Crawler$CreationTime' => 'The time that the crawler was created.
', 'Crawler$LastUpdated' => 'The time that the crawler was last updated.
', 'CrawlerHistory$StartTime' => 'The date and time on which the crawl started.
', 'CrawlerHistory$EndTime' => 'The date and time on which the crawl ended.
', 'CsvClassifier$CreationTime' => 'The time that this classifier was registered.
', 'CsvClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'DataQualityResult$StartedOn' => 'The date and time when this data quality run started.
', 'DataQualityResult$CompletedOn' => 'The date and time when this data quality run completed.
', 'DataQualityResultDescription$StartedOn' => 'The time that the run started for this data quality result.
', 'DataQualityResultFilterCriteria$StartedAfter' => 'Filter results by runs that started after this time.
', 'DataQualityResultFilterCriteria$StartedBefore' => 'Filter results by runs that started before this time.
', 'DataQualityRuleRecommendationRunDescription$StartedOn' => 'The date and time when this run started.
', 'DataQualityRuleRecommendationRunFilter$StartedBefore' => 'Filter based on time for results started before provided time.
', 'DataQualityRuleRecommendationRunFilter$StartedAfter' => 'Filter based on time for results started after provided time.
', 'DataQualityRulesetEvaluationRunDescription$StartedOn' => 'The date and time when the run started.
', 'DataQualityRulesetEvaluationRunFilter$StartedBefore' => 'Filter results by runs that started before this time.
', 'DataQualityRulesetEvaluationRunFilter$StartedAfter' => 'Filter results by runs that started after this time.
', 'DataQualityRulesetFilterCriteria$CreatedBefore' => 'Filter on rulesets created before this date.
', 'DataQualityRulesetFilterCriteria$CreatedAfter' => 'Filter on rulesets created after this date.
', 'DataQualityRulesetFilterCriteria$LastModifiedBefore' => 'Filter on rulesets last modified before this date.
', 'DataQualityRulesetFilterCriteria$LastModifiedAfter' => 'Filter on rulesets last modified after this date.
', 'DataQualityRulesetListDetails$CreatedOn' => 'The date and time the data quality ruleset was created.
', 'DataQualityRulesetListDetails$LastModifiedOn' => 'The date and time the data quality ruleset was last modified.
', 'Database$CreateTime' => 'The time at which the metadata database was created in the catalog.
', 'DateColumnStatisticsData$MinimumValue' => 'The lowest value in the column.
', 'DateColumnStatisticsData$MaximumValue' => 'The highest value in the column.
', 'GetDataQualityResultResponse$StartedOn' => 'The date and time when the run for this data quality result started.
', 'GetDataQualityResultResponse$CompletedOn' => 'The date and time when the run for this data quality result was completed.
', 'GetDataQualityRuleRecommendationRunResponse$StartedOn' => 'The date and time when this run started.
', 'GetDataQualityRuleRecommendationRunResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality rule recommendation run was modified.
', 'GetDataQualityRuleRecommendationRunResponse$CompletedOn' => 'The date and time when this run was completed.
', 'GetDataQualityRulesetEvaluationRunResponse$StartedOn' => 'The date and time when this run started.
', 'GetDataQualityRulesetEvaluationRunResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality rule recommendation run was modified.
', 'GetDataQualityRulesetEvaluationRunResponse$CompletedOn' => 'The date and time when this run was completed.
', 'GetDataQualityRulesetResponse$CreatedOn' => 'A timestamp. The time and date that this data quality ruleset was created.
', 'GetDataQualityRulesetResponse$LastModifiedOn' => 'A timestamp. The last point in time when this data quality ruleset was modified.
', 'GetMLTaskRunResponse$StartedOn' => 'The date and time when this task run started.
', 'GetMLTaskRunResponse$LastModifiedOn' => 'The date and time when this task run was last modified.
', 'GetMLTaskRunResponse$CompletedOn' => 'The date and time when this task run was completed.
', 'GetMLTransformResponse$CreatedOn' => 'The date and time when the transform was created.
', 'GetMLTransformResponse$LastModifiedOn' => 'The date and time when the transform was last modified.
', 'GetPartitionsRequest$QueryAsOfTime' => 'The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId
.
The date and time at which the policy was created.
', 'GetResourcePolicyResponse$UpdateTime' => 'The date and time at which the policy was last updated.
', 'GetTableRequest$QueryAsOfTime' => 'The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId
.
The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId
.
The date and time at which the policy was created.
', 'GluePolicy$UpdateTime' => 'The date and time at which the policy was last updated.
', 'GrokClassifier$CreationTime' => 'The time that this classifier was registered.
', 'GrokClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'JsonClassifier$CreationTime' => 'The time that this classifier was registered.
', 'JsonClassifier$LastUpdated' => 'The time that this classifier was last updated.
', 'LastCrawlInfo$StartTime' => 'The time at which the crawl started.
', 'MLTransform$CreatedOn' => 'A timestamp. The time and date that this machine learning transform was created.
', 'MLTransform$LastModifiedOn' => 'A timestamp. The last point in time when this machine learning transform was modified.
', 'Partition$CreationTime' => 'The time at which the partition was created.
', 'Partition$LastAccessTime' => 'The last time at which the partition was accessed.
', 'Partition$LastAnalyzedTime' => 'The last time at which column statistics were computed for this partition.
', 'PartitionInput$LastAccessTime' => 'The last time at which the partition was accessed.
', 'PartitionInput$LastAnalyzedTime' => 'The last time at which column statistics were computed for this partition.
', 'QuerySessionContext$QueryStartTime' => 'A timestamp provided by the query engine for when the query started.
', 'Table$CreateTime' => 'The time when the table definition was created in the Data Catalog.
', 'Table$UpdateTime' => 'The last time that the table was updated.
', 'Table$LastAccessTime' => 'The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
', 'Table$LastAnalyzedTime' => 'The last time that column statistics were computed for this table.
', 'TableInput$LastAccessTime' => 'The last time that the table was accessed.
', 'TableInput$LastAnalyzedTime' => 'The last time that column statistics were computed for this table.
', 'TaskRun$StartedOn' => 'The date and time that this task run started.
', 'TaskRun$LastModifiedOn' => 'The last point in time that the requested task run was updated.
', 'TaskRun$CompletedOn' => 'The last point in time that the requested task run was completed.
', 'TaskRunFilterCriteria$StartedBefore' => 'Filter on task runs started before this date.
', 'TaskRunFilterCriteria$StartedAfter' => 'Filter on task runs started after this date.
', 'TransformFilterCriteria$CreatedBefore' => 'The time and date before which the transforms were created.
', 'TransformFilterCriteria$CreatedAfter' => 'The time and date after which the transforms were created.
', 'TransformFilterCriteria$LastModifiedBefore' => 'Filter on transforms last modified before this date.
', 'TransformFilterCriteria$LastModifiedAfter' => 'Filter on transforms last modified after this date.
', 'UserDefinedFunction$CreateTime' => 'The time at which the function was created.
', 'XMLClassifier$CreationTime' => 'The time that this classifier was registered.
', 'XMLClassifier$LastUpdated' => 'The time that this classifier was last updated.
', ], ], 'TimestampValue' => [ 'base' => NULL, 'refs' => [ 'Blueprint$CreatedOn' => 'The date and time the blueprint was registered.
', 'Blueprint$LastModifiedOn' => 'The date and time the blueprint was last modified.
', 'BlueprintRun$StartedOn' => 'The date and time that the blueprint run started.
', 'BlueprintRun$CompletedOn' => 'The date and time that the blueprint run completed.
', 'Crawl$StartedOn' => 'The date and time on which the crawl started.
', 'Crawl$CompletedOn' => 'The date and time on which the crawl completed.
', 'CreateDevEndpointResponse$CreatedTimestamp' => 'The point in time at which this DevEndpoint
was created.
The time at which the new security configuration was created.
', 'DevEndpoint$CreatedTimestamp' => 'The point in time at which this DevEndpoint was created.
', 'DevEndpoint$LastModifiedTimestamp' => 'The point in time at which this DevEndpoint
was last modified.
The date and time when the usage profile was created.
', 'GetUsageProfileResponse$LastModifiedOn' => 'The date and time when the usage profile was last modified.
', 'Job$CreatedOn' => 'The time and date that this job definition was created.
', 'Job$LastModifiedOn' => 'The last point in time when this job definition was modified.
', 'JobRun$StartedOn' => 'The date and time at which this job run was started.
', 'JobRun$LastModifiedOn' => 'The last time that this job run was modified.
', 'JobRun$CompletedOn' => 'The date and time that this job run completed.
', 'LastActiveDefinition$LastModifiedOn' => 'The date and time the blueprint was last modified.
', 'SecurityConfiguration$CreatedTimeStamp' => 'The time at which this security configuration was created.
', 'Session$CreatedOn' => 'The time and date when the session was created.
', 'Session$CompletedOn' => 'The date and time that this session is completed.
', 'UsageProfileDefinition$CreatedOn' => 'The date and time when the usage profile was created.
', 'UsageProfileDefinition$LastModifiedOn' => 'The date and time when the usage profile was last modified.
', 'Workflow$CreatedOn' => 'The date and time when the workflow was created.
', 'Workflow$LastModifiedOn' => 'The date and time when the workflow was last modified.
', 'WorkflowRun$StartedOn' => 'The date and time when the workflow run was started.
', 'WorkflowRun$CompletedOn' => 'The date and time when the workflow run completed.
', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'GetClassifiersRequest$NextToken' => 'An optional continuation token.
', 'GetClassifiersResponse$NextToken' => 'A continuation token.
', 'GetColumnStatisticsTaskRunsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetColumnStatisticsTaskRunsResponse$NextToken' => 'A continuation token, if not all task runs have yet been returned.
', 'GetConnectionsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetConnectionsResponse$NextToken' => 'A continuation token, if the list of connections returned does not include the last of the filtered connections.
', 'GetCrawlerMetricsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetCrawlerMetricsResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'GetCrawlersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'GetCrawlersResponse$NextToken' => 'A continuation token, if the returned list has not reached the end of those defined in this customer account.
', 'GetDatabasesRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetDatabasesResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'GetPartitionIndexesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'GetPartitionIndexesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', 'GetPartitionsRequest$NextToken' => 'A continuation token, if this is not the first call to retrieve these partitions.
', 'GetPartitionsResponse$NextToken' => 'A continuation token, if the returned list of partitions does not include the last one.
', 'GetResourcePoliciesRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'GetResourcePoliciesResponse$NextToken' => 'A continuation token, if the returned list does not contain the last resource policy available.
', 'GetTableVersionsRequest$NextToken' => 'A continuation token, if this is not the first call.
', 'GetTableVersionsResponse$NextToken' => 'A continuation token, if the list of available versions does not include the last one.
', 'GetTablesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'GetTablesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', 'GetUnfilteredPartitionsMetadataRequest$NextToken' => 'A continuation token, if this is not the first call to retrieve these partitions.
', 'GetUnfilteredPartitionsMetadataResponse$NextToken' => 'A continuation token, if the returned list of partitions does not include the last one.
', 'GetUserDefinedFunctionsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'GetUserDefinedFunctionsResponse$NextToken' => 'A continuation token, if the list of functions returned does not include the last requested function.
', 'ListColumnStatisticsTaskRunsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListColumnStatisticsTaskRunsResponse$NextToken' => 'A continuation token, if not all task run IDs have yet been returned.
', 'ListCrawlersRequest$NextToken' => 'A continuation token, if this is a continuation request.
', 'ListCrawlersResponse$NextToken' => 'A continuation token, if the returned list does not contain the last metric available.
', 'ListCrawlsRequest$NextToken' => 'A continuation token, if this is a continuation call.
', 'ListCrawlsResponse$NextToken' => 'A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
', 'SearchTablesRequest$NextToken' => 'A continuation token, included if this is a continuation call.
', 'SearchTablesResponse$NextToken' => 'A continuation token, present if the current list segment is not the last.
', ], ], 'TokenUrl' => [ 'base' => NULL, 'refs' => [ 'OAuth2Properties$TokenUrl' => 'The URL of the provider\'s authentication server, to exchange an authorization code for an access token.
', 'OAuth2PropertiesInput$TokenUrl' => 'The URL of the provider\'s authentication server, to exchange an authorization code for an access token.
', ], ], 'TokenUrlParameterKey' => [ 'base' => NULL, 'refs' => [ 'TokenUrlParametersMap$key' => NULL, ], ], 'TokenUrlParameterValue' => [ 'base' => NULL, 'refs' => [ 'TokenUrlParametersMap$value' => NULL, ], ], 'TokenUrlParametersMap' => [ 'base' => NULL, 'refs' => [ 'OAuth2Properties$TokenUrlParametersMap' => 'A map of parameters that are added to the token GET
request.
A map of parameters that are added to the token GET
request.
Specifies a number of records to write starting from the beginning of the dataset.
', ], ], 'TotalSegmentsInteger' => [ 'base' => NULL, 'refs' => [ 'Segment$TotalSegments' => 'The total number of segments.
', ], ], 'TransactionIdString' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableRequest$TransactionId' => 'The transaction ID at which to delete the table contents.
', 'CreateTableRequest$TransactionId' => 'The ID of the transaction.
', 'DeleteTableRequest$TransactionId' => 'The transaction ID at which to delete the table contents.
', 'GetPartitionsRequest$TransactionId' => 'The transaction ID at which to read the partition contents.
', 'GetTableRequest$TransactionId' => 'The transaction ID at which to read the table contents.
', 'GetTablesRequest$TransactionId' => 'The transaction ID at which to read the table contents.
', 'UpdateTableRequest$TransactionId' => 'The transaction ID at which to update the table contents.
', ], ], 'TransformConfigParameter' => [ 'base' => 'Specifies the parameters in the config file of the dynamic transform.
', 'refs' => [ 'TransformConfigParameterList$member' => NULL, ], ], 'TransformConfigParameterList' => [ 'base' => NULL, 'refs' => [ 'DynamicTransform$Parameters' => 'Specifies the parameters of the dynamic transform.
', ], ], 'TransformEncryption' => [ 'base' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.
', 'refs' => [ 'CreateMLTransformRequest$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', 'GetMLTransformResponse$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', 'MLTransform$TransformEncryption' => 'The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
', ], ], 'TransformFilterCriteria' => [ 'base' => 'The criteria used to filter the machine learning transforms.
', 'refs' => [ 'GetMLTransformsRequest$Filter' => 'The filter transformation criteria.
', 'ListMLTransformsRequest$Filter' => 'A TransformFilterCriteria
used to filter the machine learning transforms.
The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.
', ], ], 'TransformList' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformsResponse$Transforms' => 'A list of machine learning transforms.
', ], ], 'TransformParameters' => [ 'base' => 'The algorithm-specific parameters that are associated with the machine learning transform.
', 'refs' => [ 'CreateMLTransformRequest$Parameters' => 'The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
', 'GetMLTransformResponse$Parameters' => 'The configuration parameters that are specific to the algorithm used.
', 'MLTransform$Parameters' => 'A TransformParameters
object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.
', ], ], 'TransformSchema' => [ 'base' => NULL, 'refs' => [ 'GetMLTransformResponse$Schema' => 'The Map<Column, Type>
object that represents the schema that this transform accepts. Has an upper bound of 100 columns.
A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
', 'TransformFilterCriteria$Schema' => 'Filters on datasets with a specific schema. The Map<Column, Type>
object is an array of key-value pairs representing the schema this transform accepts, where Column
is the name of a column, and Type
is the type of the data such as an integer or string. Has an upper bound of 100 columns.
The column to be used in the sorting criteria that are associated with the machine learning transform.
', ], ], 'TransformSortCriteria' => [ 'base' => 'The sorting criteria that are associated with the machine learning transform.
', 'refs' => [ 'GetMLTransformsRequest$Sort' => 'The sorting criteria.
', 'ListMLTransformsRequest$Sort' => 'A TransformSortCriteria
used to sort the machine learning transforms.
The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
', 'MLTransform$Status' => 'The current status of the machine learning transform.
', 'TransformFilterCriteria$Status' => 'Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
', ], ], 'TransformType' => [ 'base' => NULL, 'refs' => [ 'EvaluationMetrics$TransformType' => 'The type of machine learning transform.
', 'TransformFilterCriteria$TransformType' => 'The type of machine learning transform that is used to filter the machine learning transforms.
', 'TransformParameters$TransformType' => 'The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
', ], ], 'Trigger' => [ 'base' => 'Information about a specific trigger.
', 'refs' => [ 'GetTriggerResponse$Trigger' => 'The requested trigger definition.
', 'TriggerList$member' => NULL, 'TriggerNodeDetails$Trigger' => 'The information of the trigger represented by the trigger node.
', 'UpdateTriggerResponse$Trigger' => 'The resulting trigger definition.
', ], ], 'TriggerList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTriggersResponse$Triggers' => 'A list of trigger definitions.
', 'GetTriggersResponse$Triggers' => 'A list of triggers for the specified job.
', ], ], 'TriggerNameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetTriggersRequest$TriggerNames' => 'A list of trigger names, which may be the names returned from the ListTriggers
operation.
A list of names of triggers not found.
', 'ListTriggersResponse$TriggerNames' => 'The names of all triggers in the account, or the triggers with the specified tags.
', ], ], 'TriggerNodeDetails' => [ 'base' => 'The details of a Trigger node present in the workflow.
', 'refs' => [ 'Node$TriggerDetails' => 'Details of the Trigger when the node represents a Trigger.
', ], ], 'TriggerState' => [ 'base' => NULL, 'refs' => [ 'Trigger$State' => 'The current state of the trigger.
', ], ], 'TriggerType' => [ 'base' => NULL, 'refs' => [ 'CreateTriggerRequest$Type' => 'The type of the new trigger.
', 'Trigger$Type' => 'The type of trigger that this is.
', ], ], 'TriggerUpdate' => [ 'base' => 'A structure used to provide information used to update a trigger. This object updates the previous trigger definition by overwriting it completely.
', 'refs' => [ 'UpdateTriggerRequest$TriggerUpdate' => 'The new values with which to update the trigger.
', ], ], 'TwoInputs' => [ 'base' => NULL, 'refs' => [ 'Join$Inputs' => 'The data inputs identified by their node names.
', 'Merge$Inputs' => 'The data inputs identified by their node names.
', 'Union$Inputs' => 'The node ID inputs to the transform.
', ], ], 'TypeString' => [ 'base' => NULL, 'refs' => [ 'ColumnStatistics$ColumnType' => 'The data type of the column.
', ], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'Database$LocationUri' => 'The location of the database (for example, an HDFS path).
', 'DatabaseInput$LocationUri' => 'The location of the database (for example, an HDFS path).
', 'ResourceUri$Uri' => 'The URI for accessing the resource.
', ], ], 'UnfilteredPartition' => [ 'base' => 'A partition that contains unfiltered metadata.
', 'refs' => [ 'UnfilteredPartitionList$member' => NULL, ], ], 'UnfilteredPartitionList' => [ 'base' => NULL, 'refs' => [ 'GetUnfilteredPartitionsMetadataResponse$UnfilteredPartitions' => 'A list of requested partitions.
', ], ], 'Union' => [ 'base' => 'Specifies a transform that combines the rows from two or more datasets into a single result.
', 'refs' => [ 'CodeGenConfigurationNode$Union' => 'Specifies a transform that combines the rows from two or more datasets into a single result.
', ], ], 'UnionType' => [ 'base' => NULL, 'refs' => [ 'Union$UnionType' => 'Indicates the type of Union transform.
Specify ALL
to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.
Specify DISTINCT
to remove duplicate rows in the resulting DynamicFrame.
The update behavior when the crawler finds a changed schema.
', ], ], 'UpdateBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCatalogBehavior' => [ 'base' => NULL, 'refs' => [ 'CatalogSchemaChangePolicy$UpdateBehavior' => 'The update behavior when the crawler finds a changed schema.
', 'DirectSchemaChangePolicy$UpdateBehavior' => 'The update behavior when the crawler finds a changed schema.
', ], ], 'UpdateClassifierRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateClassifierResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForPartitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForPartitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForTableRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsForTableResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateColumnStatisticsList' => [ 'base' => NULL, 'refs' => [ 'UpdateColumnStatisticsForPartitionRequest$ColumnStatisticsList' => 'A list of the column statistics.
', 'UpdateColumnStatisticsForTableRequest$ColumnStatisticsList' => 'A list of the column statistics.
', ], ], 'UpdateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerScheduleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCrawlerScheduleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCsvClassifierRequest' => [ 'base' => 'Specifies a custom CSV classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$CsvClassifier' => 'A CsvClassifier
object with updated fields.
Specifies a grok classifier to update when passed to UpdateClassifier
.
A GrokClassifier
object with updated fields.
Specifies a JSON classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$JsonClassifier' => 'A JsonClassifier
object with updated fields.
Specifies an XML classifier to be updated.
', 'refs' => [ 'UpdateClassifierRequest$XMLClassifier' => 'An XMLClassifier
object with updated fields.
The date and time the registry was updated.
', 'GetSchemaResponse$UpdatedTime' => 'The date and time the schema was updated.
', 'RegistryListItem$UpdatedTime' => 'The date the registry was updated.
', 'SchemaListItem$UpdatedTime' => 'The date and time that a schema was updated.
', ], ], 'UpsertRedshiftTargetOptions' => [ 'base' => 'The options to configure an upsert operation when writing to a Redshift target .
', 'refs' => [ 'RedshiftTarget$UpsertRedshiftOptions' => 'The set of options to configure an upsert operation when writing to a Redshift target.
', ], ], 'UriString' => [ 'base' => NULL, 'refs' => [ 'CreateJobRequest$LogUri' => 'This field is reserved for future use.
', 'DataQualityEvaluationRunAdditionalRunOptions$ResultsS3Prefix' => 'Prefix for Amazon S3 to store results.
', 'ExportLabelsTaskRunProperties$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
', 'ImportLabelsTaskRunProperties$InputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
', 'Job$LogUri' => 'This field is reserved for future use.
', 'JobUpdate$LogUri' => 'This field is reserved for future use.
', 'LabelingSetGenerationTaskRunProperties$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
', 'StartExportLabelsTaskRunRequest$OutputS3Path' => 'The Amazon S3 path where you export the labels.
', 'StartImportLabelsTaskRunRequest$InputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
', 'StartMLLabelingSetGenerationTaskRunRequest$OutputS3Path' => 'The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.
', ], ], 'UsageProfileDefinition' => [ 'base' => 'Describes an Glue usage profile.
', 'refs' => [ 'UsageProfileDefinitionList$member' => NULL, ], ], 'UsageProfileDefinitionList' => [ 'base' => NULL, 'refs' => [ 'ListUsageProfilesResponse$Profiles' => 'A list of usage profile (UsageProfileDefinition
) objects.
Represents the equivalent of a Hive user-defined function (UDF
) definition.
The requested function definition.
', 'UserDefinedFunctionList$member' => NULL, ], ], 'UserDefinedFunctionInput' => [ 'base' => 'A structure used to create or update a user-defined function.
', 'refs' => [ 'CreateUserDefinedFunctionRequest$FunctionInput' => 'A FunctionInput
object that defines the function to create in the Data Catalog.
A FunctionInput
object that redefines the function in the Data Catalog.
A list of requested function definitions.
', ], ], 'UserManagedClientApplicationClientId' => [ 'base' => NULL, 'refs' => [ 'OAuth2ClientApplication$UserManagedClientApplicationClientId' => 'The client application clientID if the ClientAppType is USER_MANAGED
.
A value could not be validated.
', 'refs' => [], ], 'ValueString' => [ 'base' => NULL, 'refs' => [ 'BoundedPartitionValueList$member' => NULL, 'ConnectionProperties$value' => NULL, 'GetUnfilteredPartitionMetadataRequest$Region' => 'Specified only if the base tables belong to a different Amazon Web Services Region.
', 'GetUnfilteredPartitionsMetadataRequest$Region' => 'Specified only if the base tables belong to a different Amazon Web Services Region.
', 'GetUnfilteredTableMetadataRequest$Region' => 'Specified only if the base tables belong to a different Amazon Web Services Region.
', 'PropertyPredicate$Key' => 'The key of the property.
', 'PropertyPredicate$Value' => 'The value of the property.
', 'SearchTablesRequest$SearchText' => 'A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
', 'SortCriterion$FieldName' => 'The name of the field on which to sort.
', 'ValueStringList$member' => NULL, ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'DeleteColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', 'DeletePartitionRequest$PartitionValues' => 'The values that define the partition.
', 'GetColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', 'GetPartitionRequest$PartitionValues' => 'The values that define the partition.
', 'GetUnfilteredPartitionMetadataRequest$PartitionValues' => '(Required) A list of partition key values.
', 'Partition$Values' => 'The values of the partition.
', 'PartitionError$PartitionValues' => 'The values that define the partition.
', 'PartitionInput$Values' => 'The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
', 'PartitionValueList$Values' => 'The list of values.
', 'UpdateColumnStatisticsForPartitionRequest$PartitionValues' => 'A list of partition values identifying the partition.
', ], ], 'VersionId' => [ 'base' => NULL, 'refs' => [ 'Crawler$Version' => 'The version of the crawler.
', 'CsvClassifier$Version' => 'The version of this classifier.
', 'GrokClassifier$Version' => 'The version of this classifier.
', 'JsonClassifier$Version' => 'The version of this classifier.
', 'XMLClassifier$Version' => 'The version of this classifier.
', ], ], 'VersionLongNumber' => [ 'base' => NULL, 'refs' => [ 'CreateSchemaResponse$LatestSchemaVersion' => 'The latest version of the schema associated with the returned schema definition.
', 'CreateSchemaResponse$NextSchemaVersion' => 'The next version of the schema associated with the returned schema definition.
', 'GetSchemaResponse$LatestSchemaVersion' => 'The latest version of the schema associated with the returned schema definition.
', 'GetSchemaResponse$NextSchemaVersion' => 'The next version of the schema associated with the returned schema definition.
', 'GetSchemaVersionResponse$VersionNumber' => 'The version number of the schema.
', 'PutSchemaVersionMetadataResponse$VersionNumber' => 'The version number of the schema.
', 'RegisterSchemaVersionResponse$VersionNumber' => 'The version of this schema (for sync flow only, in case this is the first version).
', 'RemoveSchemaVersionMetadataResponse$VersionNumber' => 'The version number of the schema.
', 'SchemaReference$SchemaVersionNumber' => 'The version number of the schema.
', 'SchemaVersionErrorItem$VersionNumber' => 'The version number of the schema.
', 'SchemaVersionListItem$VersionNumber' => 'The version number of the schema.
', 'SchemaVersionNumber$VersionNumber' => 'The version number of the schema.
', ], ], 'VersionMismatchException' => [ 'base' => 'There was a version conflict.
', 'refs' => [], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteTableVersionList$member' => NULL, 'DeleteTableVersionRequest$VersionId' => 'The ID of the table version to be deleted. A VersionID
is a string representation of an integer. Each version is incremented by 1.
The ID value of the table version to be retrieved. A VersionID
is a string representation of an integer. Each version is incremented by 1.
The table version for the Iceberg table. Defaults to 2.
', 'Table$VersionId' => 'The ID of the table version.
', 'TableVersion$VersionId' => 'The ID value that identifies this table version. A VersionId
is a string representation of an integer. Each version is incremented by 1.
The ID value of the version in question. A VersionID
is a string representation of an integer. Each version is incremented by 1.
The version ID at which to update the table contents.
', ], ], 'VersionsString' => [ 'base' => NULL, 'refs' => [ 'DeleteSchemaVersionsInput$Versions' => 'A version range may be supplied which may be of the format:
a single version number, 5
a range, 5-8 : deletes versions 5, 6, 7, 8
A structure containing details for representations.
', 'refs' => [ 'Table$ViewDefinition' => 'A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
', ], ], 'ViewDefinitionInput' => [ 'base' => 'A structure containing details for creating or updating an Glue view.
', 'refs' => [ 'TableInput$ViewDefinition' => 'A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
', ], ], 'ViewDialect' => [ 'base' => NULL, 'refs' => [ 'SupportedDialect$Dialect' => 'The dialect of the query engine.
', 'ViewRepresentation$Dialect' => 'The dialect of the query engine.
', 'ViewRepresentationInput$Dialect' => 'A parameter that specifies the engine type of a specific representation.
', ], ], 'ViewDialectVersionString' => [ 'base' => NULL, 'refs' => [ 'SupportedDialect$DialectVersion' => 'The version of the dialect of the query engine. For example, 3.0.0.
', 'ViewRepresentation$DialectVersion' => 'The version of the dialect of the query engine. For example, 3.0.0.
', 'ViewRepresentationInput$DialectVersion' => 'A parameter that specifies the version of the engine of a specific representation.
', ], ], 'ViewRepresentation' => [ 'base' => 'A structure that contains the dialect of the view, and the query that defines the view.
', 'refs' => [ 'ViewRepresentationList$member' => NULL, ], ], 'ViewRepresentationInput' => [ 'base' => 'A structure containing details of a representation to update or create a Lake Formation view.
', 'refs' => [ 'ViewRepresentationInputList$member' => NULL, ], ], 'ViewRepresentationInputList' => [ 'base' => NULL, 'refs' => [ 'ViewDefinitionInput$Representations' => 'A list of structures that contains the dialect of the view, and the query that defines the view.
', ], ], 'ViewRepresentationList' => [ 'base' => NULL, 'refs' => [ 'ViewDefinition$Representations' => 'A list of representations.
', ], ], 'ViewSubObjectsList' => [ 'base' => NULL, 'refs' => [ 'ViewDefinition$SubObjects' => 'A list of table Amazon Resource Names (ARNs).
', 'ViewDefinitionInput$SubObjects' => 'A list of base table ARNs that make up the view.
', ], ], 'ViewTextString' => [ 'base' => NULL, 'refs' => [ 'Table$ViewOriginalText' => 'Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW
, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'TableInput$ViewOriginalText' => 'Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW
, certain Athena configuration encoded in base64.
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
', 'ViewRepresentation$ViewOriginalText' => 'The SELECT
query provided by the customer during CREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead). ViewOriginalText
is used for cases like SHOW CREATE VIEW
where users want to see the original DDL command that created the view.
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText
to ViewExpandedText
. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
A string that represents the original SQL query that describes the view.
', 'ViewRepresentationInput$ViewExpandedText' => 'A string that represents the SQL query that describes the view with expanded resource ARNs
', ], ], 'ViewUpdateAction' => [ 'base' => NULL, 'refs' => [ 'UpdateTableRequest$ViewUpdateAction' => 'The operation to be performed when updating the view.
', ], ], 'WorkerType' => [ 'base' => NULL, 'refs' => [ 'CreateDevEndpointRequest$WorkerType' => 'The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.
', 'CreateJobRequest$WorkerType' => 'The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
MaxCapacity
and NumberOfWorkers
must both be at least 1.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
MaxCapacity
is a mutually exclusive option with NumberOfWorkers
and WorkerType
.
If either NumberOfWorkers
or WorkerType
is set, then MaxCapacity
cannot be set.
If MaxCapacity
is set then neither NumberOfWorkers
or WorkerType
can be set.
If WorkerType
is set, then NumberOfWorkers
is required (and vice versa).
MaxCapacity
and NumberOfWorkers
must both be at least 1.
The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X
, G.2X
, G.4X
, or G.8X
for Spark sessions. Accepts the value Z.2X
for Ray sessions.
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
For the Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
A workflow is a collection of multiple dependent Glue jobs and crawlers that are run to complete a complex ETL task. A workflow manages the execution and monitoring of all its jobs and crawlers.
', 'refs' => [ 'GetWorkflowResponse$Workflow' => 'The resource metadata for the workflow.
', 'Workflows$member' => NULL, ], ], 'WorkflowGraph' => [ 'base' => 'A workflow graph represents the complete workflow containing all the Glue components present in the workflow and all the directed connections between them.
', 'refs' => [ 'Workflow$Graph' => 'The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
', 'WorkflowRun$Graph' => 'The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
', ], ], 'WorkflowNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetWorkflowsRequest$Names' => 'A list of workflow names, which may be the names returned from the ListWorkflows
operation.
A list of names of workflows not found.
', 'ListWorkflowsResponse$Workflows' => 'List of names of workflows in the account.
', ], ], 'WorkflowRun' => [ 'base' => 'A workflow run is an execution of a workflow providing all the runtime information.
', 'refs' => [ 'GetWorkflowRunResponse$Run' => 'The requested workflow run metadata.
', 'Workflow$LastRun' => 'The information about the last execution of the workflow.
', 'WorkflowRuns$member' => NULL, ], ], 'WorkflowRunProperties' => [ 'base' => NULL, 'refs' => [ 'CreateWorkflowRequest$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow.
', 'GetWorkflowRunPropertiesResponse$RunProperties' => 'The workflow run properties which were set during the specified run.
', 'PutWorkflowRunPropertiesRequest$RunProperties' => 'The properties to put for the specified run.
', 'StartWorkflowRunRequest$RunProperties' => 'The workflow run properties for the new workflow run.
', 'UpdateWorkflowRequest$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow.
', 'Workflow$DefaultRunProperties' => 'A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
', 'WorkflowRun$WorkflowRunProperties' => 'The workflow run properties which were set during the run.
', ], ], 'WorkflowRunStatistics' => [ 'base' => 'Workflow run statistics provides statistics about the workflow run.
', 'refs' => [ 'WorkflowRun$Statistics' => 'The statistics of the run.
', ], ], 'WorkflowRunStatus' => [ 'base' => NULL, 'refs' => [ 'WorkflowRun$Status' => 'The status of the workflow run.
', ], ], 'WorkflowRuns' => [ 'base' => NULL, 'refs' => [ 'GetWorkflowRunsResponse$Runs' => 'A list of workflow run metadata objects.
', ], ], 'Workflows' => [ 'base' => NULL, 'refs' => [ 'BatchGetWorkflowsResponse$Workflows' => 'A list of workflow resource metadata.
', ], ], 'XMLClassifier' => [ 'base' => 'A classifier for XML
content.
A classifier for XML content.
', ], ], 'databaseNameString' => [ 'base' => NULL, 'refs' => [ 'BatchGetTableOptimizerEntry$databaseName' => 'The name of the database in the catalog in which the table resides.
', 'BatchGetTableOptimizerError$databaseName' => 'The name of the database in the catalog in which the table resides.
', 'BatchTableOptimizer$databaseName' => 'The name of the database in the catalog in which the table resides.
', ], ], 'tableNameString' => [ 'base' => NULL, 'refs' => [ 'BatchGetTableOptimizerEntry$tableName' => 'The name of the table.
', 'BatchGetTableOptimizerError$tableName' => 'The name of the table.
', 'BatchTableOptimizer$tableName' => 'The name of the table.
', ], ], ],]; diff --git a/src/data/kinesisanalyticsv2/2018-05-23/api-2.json b/src/data/kinesisanalyticsv2/2018-05-23/api-2.json index a69f919ebd..3058971a53 100644 --- a/src/data/kinesisanalyticsv2/2018-05-23/api-2.json +++ b/src/data/kinesisanalyticsv2/2018-05-23/api-2.json @@ -12,7 +12,8 @@ "signatureVersion":"v4", "signingName":"kinesisanalytics", "targetPrefix":"KinesisAnalytics_20180523", - "uid":"kinesisanalyticsv2-2018-05-23" + "uid":"kinesisanalyticsv2-2018-05-23", + "auth":["aws.auth#sigv4"] }, "operations":{ "AddApplicationCloudWatchLoggingOption":{ @@ -2471,7 +2472,8 @@ "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", - "FLINK-1_18" + "FLINK-1_18", + "FLINK-1_19" ] }, "S3ApplicationCodeLocationDescription":{ diff --git a/src/data/kinesisanalyticsv2/2018-05-23/api-2.json.php b/src/data/kinesisanalyticsv2/2018-05-23/api-2.json.php index 3c54437066..f29761520c 100644 --- a/src/data/kinesisanalyticsv2/2018-05-23/api-2.json.php +++ b/src/data/kinesisanalyticsv2/2018-05-23/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-05-23', 'endpointPrefix' => 'kinesisanalytics', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'Kinesis Analytics V2', 'serviceFullName' => 'Amazon Kinesis Analytics', 'serviceId' => 'Kinesis Analytics V2', 'signatureVersion' => 'v4', 'signingName' => 'kinesisanalytics', 'targetPrefix' => 'KinesisAnalytics_20180523', 'uid' => 'kinesisanalyticsv2-2018-05-23', ], 'operations' => [ 'AddApplicationCloudWatchLoggingOption' => [ 'name' => 'AddApplicationCloudWatchLoggingOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationCloudWatchLoggingOptionRequest', ], 'output' => [ 'shape' => 'AddApplicationCloudWatchLoggingOptionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'AddApplicationInput' => [ 'name' => 'AddApplicationInput', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationInputRequest', ], 'output' => [ 'shape' => 'AddApplicationInputResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'CodeValidationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddApplicationInputProcessingConfiguration' => [ 'name' => 'AddApplicationInputProcessingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationInputProcessingConfigurationRequest', ], 'output' => [ 'shape' => 'AddApplicationInputProcessingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddApplicationOutput' => [ 'name' => 'AddApplicationOutput', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationOutputRequest', ], 'output' => [ 'shape' => 'AddApplicationOutputResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddApplicationReferenceDataSource' => [ 'name' => 'AddApplicationReferenceDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationReferenceDataSourceRequest', ], 'output' => [ 'shape' => 'AddApplicationReferenceDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddApplicationVpcConfiguration' => [ 'name' => 'AddApplicationVpcConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationVpcConfigurationRequest', ], 'output' => [ 'shape' => 'AddApplicationVpcConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'CreateApplication' => [ 'name' => 'CreateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateApplicationRequest', ], 'output' => [ 'shape' => 'CreateApplicationResponse', ], 'errors' => [ [ 'shape' => 'CodeValidationException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'CreateApplicationPresignedUrl' => [ 'name' => 'CreateApplicationPresignedUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateApplicationPresignedUrlRequest', ], 'output' => [ 'shape' => 'CreateApplicationPresignedUrlResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], ], ], 'CreateApplicationSnapshot' => [ 'name' => 'CreateApplicationSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateApplicationSnapshotRequest', ], 'output' => [ 'shape' => 'CreateApplicationSnapshotResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'DeleteApplication' => [ 'name' => 'DeleteApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationRequest', ], 'output' => [ 'shape' => 'DeleteApplicationResponse', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'DeleteApplicationCloudWatchLoggingOption' => [ 'name' => 'DeleteApplicationCloudWatchLoggingOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationCloudWatchLoggingOptionRequest', ], 'output' => [ 'shape' => 'DeleteApplicationCloudWatchLoggingOptionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'DeleteApplicationInputProcessingConfiguration' => [ 'name' => 'DeleteApplicationInputProcessingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationInputProcessingConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteApplicationInputProcessingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteApplicationOutput' => [ 'name' => 'DeleteApplicationOutput', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationOutputRequest', ], 'output' => [ 'shape' => 'DeleteApplicationOutputResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteApplicationReferenceDataSource' => [ 'name' => 'DeleteApplicationReferenceDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationReferenceDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteApplicationReferenceDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteApplicationSnapshot' => [ 'name' => 'DeleteApplicationSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteApplicationSnapshotResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'DeleteApplicationVpcConfiguration' => [ 'name' => 'DeleteApplicationVpcConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationVpcConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteApplicationVpcConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'DescribeApplication' => [ 'name' => 'DescribeApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeApplicationRequest', ], 'output' => [ 'shape' => 'DescribeApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeApplicationOperation' => [ 'name' => 'DescribeApplicationOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeApplicationOperationRequest', ], 'output' => [ 'shape' => 'DescribeApplicationOperationResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'DescribeApplicationSnapshot' => [ 'name' => 'DescribeApplicationSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeApplicationSnapshotRequest', ], 'output' => [ 'shape' => 'DescribeApplicationSnapshotResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'DescribeApplicationVersion' => [ 'name' => 'DescribeApplicationVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeApplicationVersionRequest', ], 'output' => [ 'shape' => 'DescribeApplicationVersionResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'DiscoverInputSchema' => [ 'name' => 'DiscoverInputSchema', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscoverInputSchemaRequest', ], 'output' => [ 'shape' => 'DiscoverInputSchemaResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnableToDetectSchemaException', ], [ 'shape' => 'ResourceProvisionedThroughputExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'ListApplicationOperations' => [ 'name' => 'ListApplicationOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListApplicationOperationsRequest', ], 'output' => [ 'shape' => 'ListApplicationOperationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'ListApplicationSnapshots' => [ 'name' => 'ListApplicationSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListApplicationSnapshotsRequest', ], 'output' => [ 'shape' => 'ListApplicationSnapshotsResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'ListApplicationVersions' => [ 'name' => 'ListApplicationVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListApplicationVersionsRequest', ], 'output' => [ 'shape' => 'ListApplicationVersionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'ListApplications' => [ 'name' => 'ListApplications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListApplicationsRequest', ], 'output' => [ 'shape' => 'ListApplicationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'RollbackApplication' => [ 'name' => 'RollbackApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RollbackApplicationRequest', ], 'output' => [ 'shape' => 'RollbackApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'StartApplication' => [ 'name' => 'StartApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartApplicationRequest', ], 'output' => [ 'shape' => 'StartApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'StopApplication' => [ 'name' => 'StopApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopApplicationRequest', ], 'output' => [ 'shape' => 'StopApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'UpdateApplication' => [ 'name' => 'UpdateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateApplicationRequest', ], 'output' => [ 'shape' => 'UpdateApplicationResponse', ], 'errors' => [ [ 'shape' => 'CodeValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'UpdateApplicationMaintenanceConfiguration' => [ 'name' => 'UpdateApplicationMaintenanceConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateApplicationMaintenanceConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateApplicationMaintenanceConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], ], 'shapes' => [ 'AddApplicationCloudWatchLoggingOptionRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CloudWatchLoggingOption', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CloudWatchLoggingOption' => [ 'shape' => 'CloudWatchLoggingOption', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], ], ], 'AddApplicationCloudWatchLoggingOptionResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CloudWatchLoggingOptionDescriptions' => [ 'shape' => 'CloudWatchLoggingOptionDescriptions', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'AddApplicationInputProcessingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'InputId', 'InputProcessingConfiguration', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'InputId' => [ 'shape' => 'Id', ], 'InputProcessingConfiguration' => [ 'shape' => 'InputProcessingConfiguration', ], ], ], 'AddApplicationInputProcessingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'InputId' => [ 'shape' => 'Id', ], 'InputProcessingConfigurationDescription' => [ 'shape' => 'InputProcessingConfigurationDescription', ], ], ], 'AddApplicationInputRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'Input', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'Input' => [ 'shape' => 'Input', ], ], ], 'AddApplicationInputResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'InputDescriptions' => [ 'shape' => 'InputDescriptions', ], ], ], 'AddApplicationOutputRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'Output', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'Output' => [ 'shape' => 'Output', ], ], ], 'AddApplicationOutputResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'OutputDescriptions' => [ 'shape' => 'OutputDescriptions', ], ], ], 'AddApplicationReferenceDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'ReferenceDataSource', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ReferenceDataSource' => [ 'shape' => 'ReferenceDataSource', ], ], ], 'AddApplicationReferenceDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ReferenceDataSourceDescriptions' => [ 'shape' => 'ReferenceDataSourceDescriptions', ], ], ], 'AddApplicationVpcConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'VpcConfiguration', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'VpcConfiguration' => [ 'shape' => 'VpcConfiguration', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], ], ], 'AddApplicationVpcConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'VpcConfigurationDescription' => [ 'shape' => 'VpcConfigurationDescription', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'ApplicationCodeConfiguration' => [ 'type' => 'structure', 'required' => [ 'CodeContentType', ], 'members' => [ 'CodeContent' => [ 'shape' => 'CodeContent', ], 'CodeContentType' => [ 'shape' => 'CodeContentType', ], ], ], 'ApplicationCodeConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'CodeContentType', ], 'members' => [ 'CodeContentType' => [ 'shape' => 'CodeContentType', ], 'CodeContentDescription' => [ 'shape' => 'CodeContentDescription', ], ], ], 'ApplicationCodeConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'CodeContentTypeUpdate' => [ 'shape' => 'CodeContentType', ], 'CodeContentUpdate' => [ 'shape' => 'CodeContentUpdate', ], ], ], 'ApplicationConfiguration' => [ 'type' => 'structure', 'members' => [ 'SqlApplicationConfiguration' => [ 'shape' => 'SqlApplicationConfiguration', ], 'FlinkApplicationConfiguration' => [ 'shape' => 'FlinkApplicationConfiguration', ], 'EnvironmentProperties' => [ 'shape' => 'EnvironmentProperties', ], 'ApplicationCodeConfiguration' => [ 'shape' => 'ApplicationCodeConfiguration', ], 'ApplicationSnapshotConfiguration' => [ 'shape' => 'ApplicationSnapshotConfiguration', ], 'ApplicationSystemRollbackConfiguration' => [ 'shape' => 'ApplicationSystemRollbackConfiguration', ], 'VpcConfigurations' => [ 'shape' => 'VpcConfigurations', ], 'ZeppelinApplicationConfiguration' => [ 'shape' => 'ZeppelinApplicationConfiguration', ], ], ], 'ApplicationConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'SqlApplicationConfigurationDescription' => [ 'shape' => 'SqlApplicationConfigurationDescription', ], 'ApplicationCodeConfigurationDescription' => [ 'shape' => 'ApplicationCodeConfigurationDescription', ], 'RunConfigurationDescription' => [ 'shape' => 'RunConfigurationDescription', ], 'FlinkApplicationConfigurationDescription' => [ 'shape' => 'FlinkApplicationConfigurationDescription', ], 'EnvironmentPropertyDescriptions' => [ 'shape' => 'EnvironmentPropertyDescriptions', ], 'ApplicationSnapshotConfigurationDescription' => [ 'shape' => 'ApplicationSnapshotConfigurationDescription', ], 'ApplicationSystemRollbackConfigurationDescription' => [ 'shape' => 'ApplicationSystemRollbackConfigurationDescription', ], 'VpcConfigurationDescriptions' => [ 'shape' => 'VpcConfigurationDescriptions', ], 'ZeppelinApplicationConfigurationDescription' => [ 'shape' => 'ZeppelinApplicationConfigurationDescription', ], ], ], 'ApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'SqlApplicationConfigurationUpdate' => [ 'shape' => 'SqlApplicationConfigurationUpdate', ], 'ApplicationCodeConfigurationUpdate' => [ 'shape' => 'ApplicationCodeConfigurationUpdate', ], 'FlinkApplicationConfigurationUpdate' => [ 'shape' => 'FlinkApplicationConfigurationUpdate', ], 'EnvironmentPropertyUpdates' => [ 'shape' => 'EnvironmentPropertyUpdates', ], 'ApplicationSnapshotConfigurationUpdate' => [ 'shape' => 'ApplicationSnapshotConfigurationUpdate', ], 'ApplicationSystemRollbackConfigurationUpdate' => [ 'shape' => 'ApplicationSystemRollbackConfigurationUpdate', ], 'VpcConfigurationUpdates' => [ 'shape' => 'VpcConfigurationUpdates', ], 'ZeppelinApplicationConfigurationUpdate' => [ 'shape' => 'ZeppelinApplicationConfigurationUpdate', ], ], ], 'ApplicationDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'ApplicationDetail' => [ 'type' => 'structure', 'required' => [ 'ApplicationARN', 'ApplicationName', 'RuntimeEnvironment', 'ApplicationStatus', 'ApplicationVersionId', ], 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationDescription' => [ 'shape' => 'ApplicationDescription', ], 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'RuntimeEnvironment' => [ 'shape' => 'RuntimeEnvironment', ], 'ServiceExecutionRole' => [ 'shape' => 'RoleARN', ], 'ApplicationStatus' => [ 'shape' => 'ApplicationStatus', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUpdateTimestamp' => [ 'shape' => 'Timestamp', ], 'ApplicationConfigurationDescription' => [ 'shape' => 'ApplicationConfigurationDescription', ], 'CloudWatchLoggingOptionDescriptions' => [ 'shape' => 'CloudWatchLoggingOptionDescriptions', ], 'ApplicationMaintenanceConfigurationDescription' => [ 'shape' => 'ApplicationMaintenanceConfigurationDescription', ], 'ApplicationVersionUpdatedFrom' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationVersionRolledBackFrom' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationVersionCreateTimestamp' => [ 'shape' => 'Timestamp', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], 'ApplicationVersionRolledBackTo' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationMode' => [ 'shape' => 'ApplicationMode', ], ], ], 'ApplicationMaintenanceConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'ApplicationMaintenanceWindowStartTime', 'ApplicationMaintenanceWindowEndTime', ], 'members' => [ 'ApplicationMaintenanceWindowStartTime' => [ 'shape' => 'ApplicationMaintenanceWindowStartTime', ], 'ApplicationMaintenanceWindowEndTime' => [ 'shape' => 'ApplicationMaintenanceWindowEndTime', ], ], ], 'ApplicationMaintenanceConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'ApplicationMaintenanceWindowStartTimeUpdate', ], 'members' => [ 'ApplicationMaintenanceWindowStartTimeUpdate' => [ 'shape' => 'ApplicationMaintenanceWindowStartTime', ], ], ], 'ApplicationMaintenanceWindowEndTime' => [ 'type' => 'string', 'max' => 5, 'min' => 5, 'pattern' => '([01][0-9]|2[0-3]):[0-5][0-9]', ], 'ApplicationMaintenanceWindowStartTime' => [ 'type' => 'string', 'max' => 5, 'min' => 5, 'pattern' => '([01][0-9]|2[0-3]):[0-5][0-9]', ], 'ApplicationMode' => [ 'type' => 'string', 'enum' => [ 'STREAMING', 'INTERACTIVE', ], ], 'ApplicationName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'ApplicationOperationInfo' => [ 'type' => 'structure', 'members' => [ 'Operation' => [ 'shape' => 'Operation', ], 'OperationId' => [ 'shape' => 'OperationId', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'OperationStatus' => [ 'shape' => 'OperationStatus', ], ], ], 'ApplicationOperationInfoDetails' => [ 'type' => 'structure', 'required' => [ 'Operation', 'StartTime', 'EndTime', 'OperationStatus', ], 'members' => [ 'Operation' => [ 'shape' => 'Operation', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'OperationStatus' => [ 'shape' => 'OperationStatus', ], 'ApplicationVersionChangeDetails' => [ 'shape' => 'ApplicationVersionChangeDetails', ], 'OperationFailureDetails' => [ 'shape' => 'OperationFailureDetails', ], ], ], 'ApplicationOperationInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApplicationOperationInfo', ], ], 'ApplicationRestoreConfiguration' => [ 'type' => 'structure', 'required' => [ 'ApplicationRestoreType', ], 'members' => [ 'ApplicationRestoreType' => [ 'shape' => 'ApplicationRestoreType', ], 'SnapshotName' => [ 'shape' => 'SnapshotName', ], ], ], 'ApplicationRestoreType' => [ 'type' => 'string', 'enum' => [ 'SKIP_RESTORE_FROM_SNAPSHOT', 'RESTORE_FROM_LATEST_SNAPSHOT', 'RESTORE_FROM_CUSTOM_SNAPSHOT', ], ], 'ApplicationSnapshotConfiguration' => [ 'type' => 'structure', 'required' => [ 'SnapshotsEnabled', ], 'members' => [ 'SnapshotsEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationSnapshotConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'SnapshotsEnabled', ], 'members' => [ 'SnapshotsEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationSnapshotConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'SnapshotsEnabledUpdate', ], 'members' => [ 'SnapshotsEnabledUpdate' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationStatus' => [ 'type' => 'string', 'enum' => [ 'DELETING', 'STARTING', 'STOPPING', 'READY', 'RUNNING', 'UPDATING', 'AUTOSCALING', 'FORCE_STOPPING', 'ROLLING_BACK', 'MAINTENANCE', 'ROLLED_BACK', ], ], 'ApplicationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApplicationSummary', ], ], 'ApplicationSummary' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'ApplicationARN', 'ApplicationStatus', 'ApplicationVersionId', 'RuntimeEnvironment', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationStatus' => [ 'shape' => 'ApplicationStatus', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'RuntimeEnvironment' => [ 'shape' => 'RuntimeEnvironment', ], 'ApplicationMode' => [ 'shape' => 'ApplicationMode', ], ], ], 'ApplicationSystemRollbackConfiguration' => [ 'type' => 'structure', 'required' => [ 'RollbackEnabled', ], 'members' => [ 'RollbackEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationSystemRollbackConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'RollbackEnabled', ], 'members' => [ 'RollbackEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationSystemRollbackConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'RollbackEnabledUpdate', ], 'members' => [ 'RollbackEnabledUpdate' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationVersionChangeDetails' => [ 'type' => 'structure', 'required' => [ 'ApplicationVersionUpdatedFrom', 'ApplicationVersionUpdatedTo', ], 'members' => [ 'ApplicationVersionUpdatedFrom' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationVersionUpdatedTo' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'ApplicationVersionId' => [ 'type' => 'long', 'max' => 999999999, 'min' => 1, ], 'ApplicationVersionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApplicationVersionSummary', ], ], 'ApplicationVersionSummary' => [ 'type' => 'structure', 'required' => [ 'ApplicationVersionId', 'ApplicationStatus', ], 'members' => [ 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationStatus' => [ 'shape' => 'ApplicationStatus', ], ], ], 'ArtifactType' => [ 'type' => 'string', 'enum' => [ 'UDF', 'DEPENDENCY_JAR', ], ], 'AuthorizedUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'BasePath' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[a-zA-Z0-9/!-_.*\'()]+', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'BucketARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'CSVMappingParameters' => [ 'type' => 'structure', 'required' => [ 'RecordRowDelimiter', 'RecordColumnDelimiter', ], 'members' => [ 'RecordRowDelimiter' => [ 'shape' => 'RecordRowDelimiter', ], 'RecordColumnDelimiter' => [ 'shape' => 'RecordColumnDelimiter', ], ], ], 'CatalogConfiguration' => [ 'type' => 'structure', 'required' => [ 'GlueDataCatalogConfiguration', ], 'members' => [ 'GlueDataCatalogConfiguration' => [ 'shape' => 'GlueDataCatalogConfiguration', ], ], ], 'CatalogConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'GlueDataCatalogConfigurationDescription', ], 'members' => [ 'GlueDataCatalogConfigurationDescription' => [ 'shape' => 'GlueDataCatalogConfigurationDescription', ], ], ], 'CatalogConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'GlueDataCatalogConfigurationUpdate', ], 'members' => [ 'GlueDataCatalogConfigurationUpdate' => [ 'shape' => 'GlueDataCatalogConfigurationUpdate', ], ], ], 'CheckpointConfiguration' => [ 'type' => 'structure', 'required' => [ 'ConfigurationType', ], 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'CheckpointingEnabled' => [ 'shape' => 'BooleanObject', ], 'CheckpointInterval' => [ 'shape' => 'CheckpointInterval', ], 'MinPauseBetweenCheckpoints' => [ 'shape' => 'MinPauseBetweenCheckpoints', ], ], ], 'CheckpointConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'CheckpointingEnabled' => [ 'shape' => 'BooleanObject', ], 'CheckpointInterval' => [ 'shape' => 'CheckpointInterval', ], 'MinPauseBetweenCheckpoints' => [ 'shape' => 'MinPauseBetweenCheckpoints', ], ], ], 'CheckpointConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'ConfigurationTypeUpdate' => [ 'shape' => 'ConfigurationType', ], 'CheckpointingEnabledUpdate' => [ 'shape' => 'BooleanObject', ], 'CheckpointIntervalUpdate' => [ 'shape' => 'CheckpointInterval', ], 'MinPauseBetweenCheckpointsUpdate' => [ 'shape' => 'MinPauseBetweenCheckpoints', ], ], ], 'CheckpointInterval' => [ 'type' => 'long', 'min' => 1, ], 'CloudWatchLoggingOption' => [ 'type' => 'structure', 'required' => [ 'LogStreamARN', ], 'members' => [ 'LogStreamARN' => [ 'shape' => 'LogStreamARN', ], ], ], 'CloudWatchLoggingOptionDescription' => [ 'type' => 'structure', 'required' => [ 'LogStreamARN', ], 'members' => [ 'CloudWatchLoggingOptionId' => [ 'shape' => 'Id', ], 'LogStreamARN' => [ 'shape' => 'LogStreamARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'CloudWatchLoggingOptionDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudWatchLoggingOptionDescription', ], ], 'CloudWatchLoggingOptionUpdate' => [ 'type' => 'structure', 'required' => [ 'CloudWatchLoggingOptionId', ], 'members' => [ 'CloudWatchLoggingOptionId' => [ 'shape' => 'Id', ], 'LogStreamARNUpdate' => [ 'shape' => 'LogStreamARN', ], ], ], 'CloudWatchLoggingOptionUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudWatchLoggingOptionUpdate', ], ], 'CloudWatchLoggingOptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudWatchLoggingOption', ], ], 'CodeContent' => [ 'type' => 'structure', 'members' => [ 'TextContent' => [ 'shape' => 'TextContent', ], 'ZipFileContent' => [ 'shape' => 'ZipFileContent', ], 'S3ContentLocation' => [ 'shape' => 'S3ContentLocation', ], ], ], 'CodeContentDescription' => [ 'type' => 'structure', 'members' => [ 'TextContent' => [ 'shape' => 'TextContent', ], 'CodeMD5' => [ 'shape' => 'CodeMD5', ], 'CodeSize' => [ 'shape' => 'CodeSize', ], 'S3ApplicationCodeLocationDescription' => [ 'shape' => 'S3ApplicationCodeLocationDescription', ], ], ], 'CodeContentType' => [ 'type' => 'string', 'enum' => [ 'PLAINTEXT', 'ZIPFILE', ], ], 'CodeContentUpdate' => [ 'type' => 'structure', 'members' => [ 'TextContentUpdate' => [ 'shape' => 'TextContent', ], 'ZipFileContentUpdate' => [ 'shape' => 'ZipFileContent', ], 'S3ContentLocationUpdate' => [ 'shape' => 'S3ContentLocationUpdate', ], ], ], 'CodeMD5' => [ 'type' => 'string', 'max' => 128, 'min' => 128, ], 'CodeSize' => [ 'type' => 'long', 'max' => 52428800, 'min' => 0, ], 'CodeValidationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ConcurrentModificationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ConditionalToken' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '[a-zA-Z0-9-_+/=]+', ], 'ConfigurationType' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'CUSTOM', ], ], 'CreateApplicationPresignedUrlRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'UrlType', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'UrlType' => [ 'shape' => 'UrlType', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], ], ], 'CreateApplicationPresignedUrlResponse' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'AuthorizedUrl', ], ], ], 'CreateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'RuntimeEnvironment', 'ServiceExecutionRole', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'ApplicationDescription' => [ 'shape' => 'ApplicationDescription', ], 'RuntimeEnvironment' => [ 'shape' => 'RuntimeEnvironment', ], 'ServiceExecutionRole' => [ 'shape' => 'RoleARN', ], 'ApplicationConfiguration' => [ 'shape' => 'ApplicationConfiguration', ], 'CloudWatchLoggingOptions' => [ 'shape' => 'CloudWatchLoggingOptions', ], 'Tags' => [ 'shape' => 'Tags', ], 'ApplicationMode' => [ 'shape' => 'ApplicationMode', ], ], ], 'CreateApplicationResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationDetail', ], 'members' => [ 'ApplicationDetail' => [ 'shape' => 'ApplicationDetail', ], ], ], 'CreateApplicationSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'SnapshotName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'SnapshotName' => [ 'shape' => 'SnapshotName', ], ], ], 'CreateApplicationSnapshotResponse' => [ 'type' => 'structure', 'members' => [], ], 'CustomArtifactConfiguration' => [ 'type' => 'structure', 'required' => [ 'ArtifactType', ], 'members' => [ 'ArtifactType' => [ 'shape' => 'ArtifactType', ], 'S3ContentLocation' => [ 'shape' => 'S3ContentLocation', ], 'MavenReference' => [ 'shape' => 'MavenReference', ], ], ], 'CustomArtifactConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ArtifactType' => [ 'shape' => 'ArtifactType', ], 'S3ContentLocationDescription' => [ 'shape' => 'S3ContentLocation', ], 'MavenReferenceDescription' => [ 'shape' => 'MavenReference', ], ], ], 'CustomArtifactsConfigurationDescriptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomArtifactConfigurationDescription', ], 'max' => 50, ], 'CustomArtifactsConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomArtifactConfiguration', ], 'max' => 50, ], 'DatabaseARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'DeleteApplicationCloudWatchLoggingOptionRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CloudWatchLoggingOptionId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CloudWatchLoggingOptionId' => [ 'shape' => 'Id', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], ], ], 'DeleteApplicationCloudWatchLoggingOptionResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CloudWatchLoggingOptionDescriptions' => [ 'shape' => 'CloudWatchLoggingOptionDescriptions', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'DeleteApplicationInputProcessingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'InputId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'InputId' => [ 'shape' => 'Id', ], ], ], 'DeleteApplicationInputProcessingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'DeleteApplicationOutputRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'OutputId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'OutputId' => [ 'shape' => 'Id', ], ], ], 'DeleteApplicationOutputResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'DeleteApplicationReferenceDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'ReferenceId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ReferenceId' => [ 'shape' => 'Id', ], ], ], 'DeleteApplicationReferenceDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'DeleteApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CreateTimestamp', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteApplicationSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'SnapshotName', 'SnapshotCreationTimestamp', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'SnapshotName' => [ 'shape' => 'SnapshotName', ], 'SnapshotCreationTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteApplicationSnapshotResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteApplicationVpcConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'VpcConfigurationId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'VpcConfigurationId' => [ 'shape' => 'Id', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], ], ], 'DeleteApplicationVpcConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'DeployAsApplicationConfiguration' => [ 'type' => 'structure', 'required' => [ 'S3ContentLocation', ], 'members' => [ 'S3ContentLocation' => [ 'shape' => 'S3ContentBaseLocation', ], ], ], 'DeployAsApplicationConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'S3ContentLocationDescription', ], 'members' => [ 'S3ContentLocationDescription' => [ 'shape' => 'S3ContentBaseLocationDescription', ], ], ], 'DeployAsApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'S3ContentLocationUpdate' => [ 'shape' => 'S3ContentBaseLocationUpdate', ], ], ], 'DescribeApplicationOperationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'OperationId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'DescribeApplicationOperationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationOperationInfoDetails' => [ 'shape' => 'ApplicationOperationInfoDetails', ], ], ], 'DescribeApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'IncludeAdditionalDetails' => [ 'shape' => 'BooleanObject', ], ], ], 'DescribeApplicationResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationDetail', ], 'members' => [ 'ApplicationDetail' => [ 'shape' => 'ApplicationDetail', ], ], ], 'DescribeApplicationSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'SnapshotName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'SnapshotName' => [ 'shape' => 'SnapshotName', ], ], ], 'DescribeApplicationSnapshotResponse' => [ 'type' => 'structure', 'required' => [ 'SnapshotDetails', ], 'members' => [ 'SnapshotDetails' => [ 'shape' => 'SnapshotDetails', ], ], ], 'DescribeApplicationVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'ApplicationVersionId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'DescribeApplicationVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationVersionDetail' => [ 'shape' => 'ApplicationDetail', ], ], ], 'DestinationSchema' => [ 'type' => 'structure', 'required' => [ 'RecordFormatType', ], 'members' => [ 'RecordFormatType' => [ 'shape' => 'RecordFormatType', ], ], ], 'DiscoverInputSchemaRequest' => [ 'type' => 'structure', 'required' => [ 'ServiceExecutionRole', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'ServiceExecutionRole' => [ 'shape' => 'RoleARN', ], 'InputStartingPositionConfiguration' => [ 'shape' => 'InputStartingPositionConfiguration', ], 'S3Configuration' => [ 'shape' => 'S3Configuration', ], 'InputProcessingConfiguration' => [ 'shape' => 'InputProcessingConfiguration', ], ], ], 'DiscoverInputSchemaResponse' => [ 'type' => 'structure', 'members' => [ 'InputSchema' => [ 'shape' => 'SourceSchema', ], 'ParsedInputRecords' => [ 'shape' => 'ParsedInputRecords', ], 'ProcessedInputRecords' => [ 'shape' => 'ProcessedInputRecords', ], 'RawInputRecords' => [ 'shape' => 'RawInputRecords', ], ], ], 'EnvironmentProperties' => [ 'type' => 'structure', 'required' => [ 'PropertyGroups', ], 'members' => [ 'PropertyGroups' => [ 'shape' => 'PropertyGroups', ], ], ], 'EnvironmentPropertyDescriptions' => [ 'type' => 'structure', 'members' => [ 'PropertyGroupDescriptions' => [ 'shape' => 'PropertyGroups', ], ], ], 'EnvironmentPropertyUpdates' => [ 'type' => 'structure', 'required' => [ 'PropertyGroups', ], 'members' => [ 'PropertyGroups' => [ 'shape' => 'PropertyGroups', ], ], ], 'ErrorInfo' => [ 'type' => 'structure', 'members' => [ 'ErrorString' => [ 'shape' => 'ErrorString', ], ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'ErrorString' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'FileKey' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'FlinkApplicationConfiguration' => [ 'type' => 'structure', 'members' => [ 'CheckpointConfiguration' => [ 'shape' => 'CheckpointConfiguration', ], 'MonitoringConfiguration' => [ 'shape' => 'MonitoringConfiguration', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'FlinkApplicationConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'CheckpointConfigurationDescription' => [ 'shape' => 'CheckpointConfigurationDescription', ], 'MonitoringConfigurationDescription' => [ 'shape' => 'MonitoringConfigurationDescription', ], 'ParallelismConfigurationDescription' => [ 'shape' => 'ParallelismConfigurationDescription', ], 'JobPlanDescription' => [ 'shape' => 'JobPlanDescription', ], ], ], 'FlinkApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'CheckpointConfigurationUpdate' => [ 'shape' => 'CheckpointConfigurationUpdate', ], 'MonitoringConfigurationUpdate' => [ 'shape' => 'MonitoringConfigurationUpdate', ], 'ParallelismConfigurationUpdate' => [ 'shape' => 'ParallelismConfigurationUpdate', ], ], ], 'FlinkRunConfiguration' => [ 'type' => 'structure', 'members' => [ 'AllowNonRestoredState' => [ 'shape' => 'BooleanObject', ], ], ], 'GlueDataCatalogConfiguration' => [ 'type' => 'structure', 'required' => [ 'DatabaseARN', ], 'members' => [ 'DatabaseARN' => [ 'shape' => 'DatabaseARN', ], ], ], 'GlueDataCatalogConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'DatabaseARN', ], 'members' => [ 'DatabaseARN' => [ 'shape' => 'DatabaseARN', ], ], ], 'GlueDataCatalogConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'DatabaseARNUpdate', ], 'members' => [ 'DatabaseARNUpdate' => [ 'shape' => 'DatabaseARN', ], ], ], 'Id' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'InAppStreamName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[^-\\s<>&]*', ], 'InAppStreamNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'InAppStreamName', ], ], 'InAppTableName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, ], 'Input' => [ 'type' => 'structure', 'required' => [ 'NamePrefix', 'InputSchema', ], 'members' => [ 'NamePrefix' => [ 'shape' => 'InAppStreamName', ], 'InputProcessingConfiguration' => [ 'shape' => 'InputProcessingConfiguration', ], 'KinesisStreamsInput' => [ 'shape' => 'KinesisStreamsInput', ], 'KinesisFirehoseInput' => [ 'shape' => 'KinesisFirehoseInput', ], 'InputParallelism' => [ 'shape' => 'InputParallelism', ], 'InputSchema' => [ 'shape' => 'SourceSchema', ], ], ], 'InputDescription' => [ 'type' => 'structure', 'members' => [ 'InputId' => [ 'shape' => 'Id', ], 'NamePrefix' => [ 'shape' => 'InAppStreamName', ], 'InAppStreamNames' => [ 'shape' => 'InAppStreamNames', ], 'InputProcessingConfigurationDescription' => [ 'shape' => 'InputProcessingConfigurationDescription', ], 'KinesisStreamsInputDescription' => [ 'shape' => 'KinesisStreamsInputDescription', ], 'KinesisFirehoseInputDescription' => [ 'shape' => 'KinesisFirehoseInputDescription', ], 'InputSchema' => [ 'shape' => 'SourceSchema', ], 'InputParallelism' => [ 'shape' => 'InputParallelism', ], 'InputStartingPositionConfiguration' => [ 'shape' => 'InputStartingPositionConfiguration', ], ], ], 'InputDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputDescription', ], ], 'InputLambdaProcessor' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'InputLambdaProcessorDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'InputLambdaProcessorUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'InputParallelism' => [ 'type' => 'structure', 'members' => [ 'Count' => [ 'shape' => 'InputParallelismCount', ], ], ], 'InputParallelismCount' => [ 'type' => 'integer', 'max' => 64, 'min' => 1, ], 'InputParallelismUpdate' => [ 'type' => 'structure', 'required' => [ 'CountUpdate', ], 'members' => [ 'CountUpdate' => [ 'shape' => 'InputParallelismCount', ], ], ], 'InputProcessingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InputLambdaProcessor', ], 'members' => [ 'InputLambdaProcessor' => [ 'shape' => 'InputLambdaProcessor', ], ], ], 'InputProcessingConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'InputLambdaProcessorDescription' => [ 'shape' => 'InputLambdaProcessorDescription', ], ], ], 'InputProcessingConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'InputLambdaProcessorUpdate', ], 'members' => [ 'InputLambdaProcessorUpdate' => [ 'shape' => 'InputLambdaProcessorUpdate', ], ], ], 'InputSchemaUpdate' => [ 'type' => 'structure', 'members' => [ 'RecordFormatUpdate' => [ 'shape' => 'RecordFormat', ], 'RecordEncodingUpdate' => [ 'shape' => 'RecordEncoding', ], 'RecordColumnUpdates' => [ 'shape' => 'RecordColumns', ], ], ], 'InputStartingPosition' => [ 'type' => 'string', 'enum' => [ 'NOW', 'TRIM_HORIZON', 'LAST_STOPPED_POINT', ], ], 'InputStartingPositionConfiguration' => [ 'type' => 'structure', 'members' => [ 'InputStartingPosition' => [ 'shape' => 'InputStartingPosition', ], ], ], 'InputUpdate' => [ 'type' => 'structure', 'required' => [ 'InputId', ], 'members' => [ 'InputId' => [ 'shape' => 'Id', ], 'NamePrefixUpdate' => [ 'shape' => 'InAppStreamName', ], 'InputProcessingConfigurationUpdate' => [ 'shape' => 'InputProcessingConfigurationUpdate', ], 'KinesisStreamsInputUpdate' => [ 'shape' => 'KinesisStreamsInputUpdate', ], 'KinesisFirehoseInputUpdate' => [ 'shape' => 'KinesisFirehoseInputUpdate', ], 'InputSchemaUpdate' => [ 'shape' => 'InputSchemaUpdate', ], 'InputParallelismUpdate' => [ 'shape' => 'InputParallelismUpdate', ], ], ], 'InputUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputUpdate', ], ], 'Inputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Input', ], ], 'InvalidApplicationConfigurationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidArgumentException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'JSONMappingParameters' => [ 'type' => 'structure', 'required' => [ 'RecordRowPath', ], 'members' => [ 'RecordRowPath' => [ 'shape' => 'RecordRowPath', ], ], ], 'JobPlanDescription' => [ 'type' => 'string', ], 'KinesisAnalyticsARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'KinesisFirehoseInput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisFirehoseInputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'KinesisFirehoseInputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisFirehoseOutput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisFirehoseOutputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'KinesisFirehoseOutputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisStreamsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisStreamsInputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'KinesisStreamsInputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisStreamsOutput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisStreamsOutputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'KinesisStreamsOutputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'LambdaOutput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'LambdaOutputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'LambdaOutputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ListApplicationOperationsInputLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListApplicationOperationsRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'Limit' => [ 'shape' => 'ListApplicationOperationsInputLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'Operation' => [ 'shape' => 'Operation', ], 'OperationStatus' => [ 'shape' => 'OperationStatus', ], ], ], 'ListApplicationOperationsResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationOperationInfoList' => [ 'shape' => 'ApplicationOperationInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationSnapshotsRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'Limit' => [ 'shape' => 'ListSnapshotsInputLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationSnapshotsResponse' => [ 'type' => 'structure', 'members' => [ 'SnapshotSummaries' => [ 'shape' => 'SnapshotSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationVersionsInputLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListApplicationVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'Limit' => [ 'shape' => 'ListApplicationVersionsInputLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationVersionSummaries' => [ 'shape' => 'ApplicationVersionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationsInputLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListApplicationsRequest' => [ 'type' => 'structure', 'members' => [ 'Limit' => [ 'shape' => 'ListApplicationsInputLimit', ], 'NextToken' => [ 'shape' => 'ApplicationName', ], ], ], 'ListApplicationsResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationSummaries', ], 'members' => [ 'ApplicationSummaries' => [ 'shape' => 'ApplicationSummaries', ], 'NextToken' => [ 'shape' => 'ApplicationName', ], ], ], 'ListSnapshotsInputLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'KinesisAnalyticsARN', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', ], ], ], 'LogLevel' => [ 'type' => 'string', 'enum' => [ 'INFO', 'WARN', 'ERROR', 'DEBUG', ], ], 'LogStreamARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'MappingParameters' => [ 'type' => 'structure', 'members' => [ 'JSONMappingParameters' => [ 'shape' => 'JSONMappingParameters', ], 'CSVMappingParameters' => [ 'shape' => 'CSVMappingParameters', ], ], ], 'MavenArtifactId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'MavenGroupId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'MavenReference' => [ 'type' => 'structure', 'required' => [ 'GroupId', 'ArtifactId', 'Version', ], 'members' => [ 'GroupId' => [ 'shape' => 'MavenGroupId', ], 'ArtifactId' => [ 'shape' => 'MavenArtifactId', ], 'Version' => [ 'shape' => 'MavenVersion', ], ], ], 'MavenVersion' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'MetricsLevel' => [ 'type' => 'string', 'enum' => [ 'APPLICATION', 'TASK', 'OPERATOR', 'PARALLELISM', ], ], 'MinPauseBetweenCheckpoints' => [ 'type' => 'long', 'min' => 0, ], 'MonitoringConfiguration' => [ 'type' => 'structure', 'required' => [ 'ConfigurationType', ], 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'MetricsLevel' => [ 'shape' => 'MetricsLevel', ], 'LogLevel' => [ 'shape' => 'LogLevel', ], ], ], 'MonitoringConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'MetricsLevel' => [ 'shape' => 'MetricsLevel', ], 'LogLevel' => [ 'shape' => 'LogLevel', ], ], ], 'MonitoringConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'ConfigurationTypeUpdate' => [ 'shape' => 'ConfigurationType', ], 'MetricsLevelUpdate' => [ 'shape' => 'MetricsLevel', ], 'LogLevelUpdate' => [ 'shape' => 'LogLevel', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'ObjectVersion' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'Operation' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'OperationFailureDetails' => [ 'type' => 'structure', 'members' => [ 'RollbackOperationId' => [ 'shape' => 'OperationId', ], 'ErrorInfo' => [ 'shape' => 'ErrorInfo', ], ], ], 'OperationId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'OperationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'CANCELLED', 'SUCCESSFUL', 'FAILED', ], ], 'Output' => [ 'type' => 'structure', 'required' => [ 'Name', 'DestinationSchema', ], 'members' => [ 'Name' => [ 'shape' => 'InAppStreamName', ], 'KinesisStreamsOutput' => [ 'shape' => 'KinesisStreamsOutput', ], 'KinesisFirehoseOutput' => [ 'shape' => 'KinesisFirehoseOutput', ], 'LambdaOutput' => [ 'shape' => 'LambdaOutput', ], 'DestinationSchema' => [ 'shape' => 'DestinationSchema', ], ], ], 'OutputDescription' => [ 'type' => 'structure', 'members' => [ 'OutputId' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'InAppStreamName', ], 'KinesisStreamsOutputDescription' => [ 'shape' => 'KinesisStreamsOutputDescription', ], 'KinesisFirehoseOutputDescription' => [ 'shape' => 'KinesisFirehoseOutputDescription', ], 'LambdaOutputDescription' => [ 'shape' => 'LambdaOutputDescription', ], 'DestinationSchema' => [ 'shape' => 'DestinationSchema', ], ], ], 'OutputDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputDescription', ], ], 'OutputUpdate' => [ 'type' => 'structure', 'required' => [ 'OutputId', ], 'members' => [ 'OutputId' => [ 'shape' => 'Id', ], 'NameUpdate' => [ 'shape' => 'InAppStreamName', ], 'KinesisStreamsOutputUpdate' => [ 'shape' => 'KinesisStreamsOutputUpdate', ], 'KinesisFirehoseOutputUpdate' => [ 'shape' => 'KinesisFirehoseOutputUpdate', ], 'LambdaOutputUpdate' => [ 'shape' => 'LambdaOutputUpdate', ], 'DestinationSchemaUpdate' => [ 'shape' => 'DestinationSchema', ], ], ], 'OutputUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputUpdate', ], ], 'Outputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Output', ], ], 'Parallelism' => [ 'type' => 'integer', 'min' => 1, ], 'ParallelismConfiguration' => [ 'type' => 'structure', 'required' => [ 'ConfigurationType', ], 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'Parallelism' => [ 'shape' => 'Parallelism', ], 'ParallelismPerKPU' => [ 'shape' => 'ParallelismPerKPU', ], 'AutoScalingEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ParallelismConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'Parallelism' => [ 'shape' => 'Parallelism', ], 'ParallelismPerKPU' => [ 'shape' => 'ParallelismPerKPU', ], 'CurrentParallelism' => [ 'shape' => 'Parallelism', ], 'AutoScalingEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ParallelismConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'ConfigurationTypeUpdate' => [ 'shape' => 'ConfigurationType', ], 'ParallelismUpdate' => [ 'shape' => 'Parallelism', ], 'ParallelismPerKPUUpdate' => [ 'shape' => 'ParallelismPerKPU', ], 'AutoScalingEnabledUpdate' => [ 'shape' => 'BooleanObject', ], ], ], 'ParallelismPerKPU' => [ 'type' => 'integer', 'min' => 1, ], 'ParsedInputRecord' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParsedInputRecordField', ], ], 'ParsedInputRecordField' => [ 'type' => 'string', ], 'ParsedInputRecords' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParsedInputRecord', ], ], 'ProcessedInputRecord' => [ 'type' => 'string', ], 'ProcessedInputRecords' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessedInputRecord', ], ], 'PropertyGroup' => [ 'type' => 'structure', 'required' => [ 'PropertyGroupId', 'PropertyMap', ], 'members' => [ 'PropertyGroupId' => [ 'shape' => 'Id', ], 'PropertyMap' => [ 'shape' => 'PropertyMap', ], ], ], 'PropertyGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyGroup', ], 'max' => 50, ], 'PropertyKey' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'PropertyMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PropertyKey', ], 'value' => [ 'shape' => 'PropertyValue', ], 'max' => 50, 'min' => 1, ], 'PropertyValue' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'RawInputRecord' => [ 'type' => 'string', ], 'RawInputRecords' => [ 'type' => 'list', 'member' => [ 'shape' => 'RawInputRecord', ], ], 'RecordColumn' => [ 'type' => 'structure', 'required' => [ 'Name', 'SqlType', ], 'members' => [ 'Name' => [ 'shape' => 'RecordColumnName', ], 'Mapping' => [ 'shape' => 'RecordColumnMapping', ], 'SqlType' => [ 'shape' => 'RecordColumnSqlType', ], ], ], 'RecordColumnDelimiter' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'RecordColumnMapping' => [ 'type' => 'string', 'max' => 65535, 'min' => 0, ], 'RecordColumnName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[^-\\s<>&]*', ], 'RecordColumnSqlType' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'RecordColumns' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordColumn', ], 'max' => 1000, 'min' => 1, ], 'RecordEncoding' => [ 'type' => 'string', 'max' => 5, 'min' => 5, 'pattern' => 'UTF-8', ], 'RecordFormat' => [ 'type' => 'structure', 'required' => [ 'RecordFormatType', ], 'members' => [ 'RecordFormatType' => [ 'shape' => 'RecordFormatType', ], 'MappingParameters' => [ 'shape' => 'MappingParameters', ], ], ], 'RecordFormatType' => [ 'type' => 'string', 'enum' => [ 'JSON', 'CSV', ], ], 'RecordRowDelimiter' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'RecordRowPath' => [ 'type' => 'string', 'max' => 65535, 'min' => 1, 'pattern' => '^(?=^\\$)(?=^\\S+$).*$', ], 'ReferenceDataSource' => [ 'type' => 'structure', 'required' => [ 'TableName', 'ReferenceSchema', ], 'members' => [ 'TableName' => [ 'shape' => 'InAppTableName', ], 'S3ReferenceDataSource' => [ 'shape' => 'S3ReferenceDataSource', ], 'ReferenceSchema' => [ 'shape' => 'SourceSchema', ], ], ], 'ReferenceDataSourceDescription' => [ 'type' => 'structure', 'required' => [ 'ReferenceId', 'TableName', 'S3ReferenceDataSourceDescription', ], 'members' => [ 'ReferenceId' => [ 'shape' => 'Id', ], 'TableName' => [ 'shape' => 'InAppTableName', ], 'S3ReferenceDataSourceDescription' => [ 'shape' => 'S3ReferenceDataSourceDescription', ], 'ReferenceSchema' => [ 'shape' => 'SourceSchema', ], ], ], 'ReferenceDataSourceDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceDataSourceDescription', ], ], 'ReferenceDataSourceUpdate' => [ 'type' => 'structure', 'required' => [ 'ReferenceId', ], 'members' => [ 'ReferenceId' => [ 'shape' => 'Id', ], 'TableNameUpdate' => [ 'shape' => 'InAppTableName', ], 'S3ReferenceDataSourceUpdate' => [ 'shape' => 'S3ReferenceDataSourceUpdate', ], 'ReferenceSchemaUpdate' => [ 'shape' => 'SourceSchema', ], ], ], 'ReferenceDataSourceUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceDataSourceUpdate', ], ], 'ReferenceDataSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceDataSource', ], ], 'ResourceARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceProvisionedThroughputExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'RoleARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'RollbackApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'RollbackApplicationResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationDetail', ], 'members' => [ 'ApplicationDetail' => [ 'shape' => 'ApplicationDetail', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'RunConfiguration' => [ 'type' => 'structure', 'members' => [ 'FlinkRunConfiguration' => [ 'shape' => 'FlinkRunConfiguration', ], 'SqlRunConfigurations' => [ 'shape' => 'SqlRunConfigurations', ], 'ApplicationRestoreConfiguration' => [ 'shape' => 'ApplicationRestoreConfiguration', ], ], ], 'RunConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ApplicationRestoreConfigurationDescription' => [ 'shape' => 'ApplicationRestoreConfiguration', ], 'FlinkRunConfigurationDescription' => [ 'shape' => 'FlinkRunConfiguration', ], ], ], 'RunConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'FlinkRunConfiguration' => [ 'shape' => 'FlinkRunConfiguration', ], 'ApplicationRestoreConfiguration' => [ 'shape' => 'ApplicationRestoreConfiguration', ], ], ], 'RuntimeEnvironment' => [ 'type' => 'string', 'enum' => [ 'SQL-1_0', 'FLINK-1_6', 'FLINK-1_8', 'ZEPPELIN-FLINK-1_0', 'FLINK-1_11', 'FLINK-1_13', 'ZEPPELIN-FLINK-2_0', 'FLINK-1_15', 'ZEPPELIN-FLINK-3_0', 'FLINK-1_18', ], ], 'S3ApplicationCodeLocationDescription' => [ 'type' => 'structure', 'required' => [ 'BucketARN', 'FileKey', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], 'ObjectVersion' => [ 'shape' => 'ObjectVersion', ], ], ], 'S3Configuration' => [ 'type' => 'structure', 'required' => [ 'BucketARN', 'FileKey', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], ], ], 'S3ContentBaseLocation' => [ 'type' => 'structure', 'required' => [ 'BucketARN', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'BasePath' => [ 'shape' => 'BasePath', ], ], ], 'S3ContentBaseLocationDescription' => [ 'type' => 'structure', 'required' => [ 'BucketARN', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'BasePath' => [ 'shape' => 'BasePath', ], ], ], 'S3ContentBaseLocationUpdate' => [ 'type' => 'structure', 'members' => [ 'BucketARNUpdate' => [ 'shape' => 'BucketARN', ], 'BasePathUpdate' => [ 'shape' => 'BasePath', ], ], ], 'S3ContentLocation' => [ 'type' => 'structure', 'required' => [ 'BucketARN', 'FileKey', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], 'ObjectVersion' => [ 'shape' => 'ObjectVersion', ], ], ], 'S3ContentLocationUpdate' => [ 'type' => 'structure', 'members' => [ 'BucketARNUpdate' => [ 'shape' => 'BucketARN', ], 'FileKeyUpdate' => [ 'shape' => 'FileKey', ], 'ObjectVersionUpdate' => [ 'shape' => 'ObjectVersion', ], ], ], 'S3ReferenceDataSource' => [ 'type' => 'structure', 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], ], ], 'S3ReferenceDataSourceDescription' => [ 'type' => 'structure', 'required' => [ 'BucketARN', 'FileKey', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], 'ReferenceRoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'S3ReferenceDataSourceUpdate' => [ 'type' => 'structure', 'members' => [ 'BucketARNUpdate' => [ 'shape' => 'BucketARN', ], 'FileKeyUpdate' => [ 'shape' => 'FileKey', ], ], ], 'SecurityGroupId' => [ 'type' => 'string', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, 'fault' => true, ], 'SessionExpirationDurationInSeconds' => [ 'type' => 'long', 'max' => 43200, 'min' => 1800, ], 'SnapshotDetails' => [ 'type' => 'structure', 'required' => [ 'SnapshotName', 'SnapshotStatus', 'ApplicationVersionId', ], 'members' => [ 'SnapshotName' => [ 'shape' => 'SnapshotName', ], 'SnapshotStatus' => [ 'shape' => 'SnapshotStatus', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'SnapshotCreationTimestamp' => [ 'shape' => 'Timestamp', ], 'RuntimeEnvironment' => [ 'shape' => 'RuntimeEnvironment', ], ], ], 'SnapshotName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'SnapshotStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'READY', 'DELETING', 'FAILED', ], ], 'SnapshotSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotDetails', ], ], 'SourceSchema' => [ 'type' => 'structure', 'required' => [ 'RecordFormat', 'RecordColumns', ], 'members' => [ 'RecordFormat' => [ 'shape' => 'RecordFormat', ], 'RecordEncoding' => [ 'shape' => 'RecordEncoding', ], 'RecordColumns' => [ 'shape' => 'RecordColumns', ], ], ], 'SqlApplicationConfiguration' => [ 'type' => 'structure', 'members' => [ 'Inputs' => [ 'shape' => 'Inputs', ], 'Outputs' => [ 'shape' => 'Outputs', ], 'ReferenceDataSources' => [ 'shape' => 'ReferenceDataSources', ], ], ], 'SqlApplicationConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'InputDescriptions' => [ 'shape' => 'InputDescriptions', ], 'OutputDescriptions' => [ 'shape' => 'OutputDescriptions', ], 'ReferenceDataSourceDescriptions' => [ 'shape' => 'ReferenceDataSourceDescriptions', ], ], ], 'SqlApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'InputUpdates' => [ 'shape' => 'InputUpdates', ], 'OutputUpdates' => [ 'shape' => 'OutputUpdates', ], 'ReferenceDataSourceUpdates' => [ 'shape' => 'ReferenceDataSourceUpdates', ], ], ], 'SqlRunConfiguration' => [ 'type' => 'structure', 'required' => [ 'InputId', 'InputStartingPositionConfiguration', ], 'members' => [ 'InputId' => [ 'shape' => 'Id', ], 'InputStartingPositionConfiguration' => [ 'shape' => 'InputStartingPositionConfiguration', ], ], ], 'SqlRunConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'SqlRunConfiguration', ], ], 'StartApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'RunConfiguration' => [ 'shape' => 'RunConfiguration', ], ], ], 'StartApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'StopApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'Force' => [ 'shape' => 'BooleanObject', ], ], ], 'StopApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'SubnetId' => [ 'type' => 'string', ], 'SubnetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 16, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'Tags', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'KinesisAnalyticsARN', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 1, ], 'TextContent' => [ 'type' => 'string', 'max' => 102400, 'min' => 0, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'UnableToDetectSchemaException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], 'RawInputRecords' => [ 'shape' => 'RawInputRecords', ], 'ProcessedInputRecords' => [ 'shape' => 'ProcessedInputRecords', ], ], 'exception' => true, ], 'UnsupportedOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'TagKeys', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'KinesisAnalyticsARN', ], 'TagKeys' => [ 'shape' => 'TagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateApplicationMaintenanceConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'ApplicationMaintenanceConfigurationUpdate', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'ApplicationMaintenanceConfigurationUpdate' => [ 'shape' => 'ApplicationMaintenanceConfigurationUpdate', ], ], ], 'UpdateApplicationMaintenanceConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationMaintenanceConfigurationDescription' => [ 'shape' => 'ApplicationMaintenanceConfigurationDescription', ], ], ], 'UpdateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationConfigurationUpdate' => [ 'shape' => 'ApplicationConfigurationUpdate', ], 'ServiceExecutionRoleUpdate' => [ 'shape' => 'RoleARN', ], 'RunConfigurationUpdate' => [ 'shape' => 'RunConfigurationUpdate', ], 'CloudWatchLoggingOptionUpdates' => [ 'shape' => 'CloudWatchLoggingOptionUpdates', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], 'RuntimeEnvironmentUpdate' => [ 'shape' => 'RuntimeEnvironment', ], ], ], 'UpdateApplicationResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationDetail', ], 'members' => [ 'ApplicationDetail' => [ 'shape' => 'ApplicationDetail', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'UrlType' => [ 'type' => 'string', 'enum' => [ 'FLINK_DASHBOARD_URL', 'ZEPPELIN_UI_URL', ], ], 'VpcConfiguration' => [ 'type' => 'structure', 'required' => [ 'SubnetIds', 'SecurityGroupIds', ], 'members' => [ 'SubnetIds' => [ 'shape' => 'SubnetIds', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], ], ], 'VpcConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'VpcConfigurationId', 'VpcId', 'SubnetIds', 'SecurityGroupIds', ], 'members' => [ 'VpcConfigurationId' => [ 'shape' => 'Id', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'SubnetIds' => [ 'shape' => 'SubnetIds', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], ], ], 'VpcConfigurationDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcConfigurationDescription', ], ], 'VpcConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'VpcConfigurationId', ], 'members' => [ 'VpcConfigurationId' => [ 'shape' => 'Id', ], 'SubnetIdUpdates' => [ 'shape' => 'SubnetIds', ], 'SecurityGroupIdUpdates' => [ 'shape' => 'SecurityGroupIds', ], ], ], 'VpcConfigurationUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcConfigurationUpdate', ], ], 'VpcConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcConfiguration', ], ], 'VpcId' => [ 'type' => 'string', ], 'ZeppelinApplicationConfiguration' => [ 'type' => 'structure', 'members' => [ 'MonitoringConfiguration' => [ 'shape' => 'ZeppelinMonitoringConfiguration', ], 'CatalogConfiguration' => [ 'shape' => 'CatalogConfiguration', ], 'DeployAsApplicationConfiguration' => [ 'shape' => 'DeployAsApplicationConfiguration', ], 'CustomArtifactsConfiguration' => [ 'shape' => 'CustomArtifactsConfigurationList', ], ], ], 'ZeppelinApplicationConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'MonitoringConfigurationDescription', ], 'members' => [ 'MonitoringConfigurationDescription' => [ 'shape' => 'ZeppelinMonitoringConfigurationDescription', ], 'CatalogConfigurationDescription' => [ 'shape' => 'CatalogConfigurationDescription', ], 'DeployAsApplicationConfigurationDescription' => [ 'shape' => 'DeployAsApplicationConfigurationDescription', ], 'CustomArtifactsConfigurationDescription' => [ 'shape' => 'CustomArtifactsConfigurationDescriptionList', ], ], ], 'ZeppelinApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'MonitoringConfigurationUpdate' => [ 'shape' => 'ZeppelinMonitoringConfigurationUpdate', ], 'CatalogConfigurationUpdate' => [ 'shape' => 'CatalogConfigurationUpdate', ], 'DeployAsApplicationConfigurationUpdate' => [ 'shape' => 'DeployAsApplicationConfigurationUpdate', ], 'CustomArtifactsConfigurationUpdate' => [ 'shape' => 'CustomArtifactsConfigurationList', ], ], ], 'ZeppelinMonitoringConfiguration' => [ 'type' => 'structure', 'required' => [ 'LogLevel', ], 'members' => [ 'LogLevel' => [ 'shape' => 'LogLevel', ], ], ], 'ZeppelinMonitoringConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'LogLevel' => [ 'shape' => 'LogLevel', ], ], ], 'ZeppelinMonitoringConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'LogLevelUpdate', ], 'members' => [ 'LogLevelUpdate' => [ 'shape' => 'LogLevel', ], ], ], 'ZipFileContent' => [ 'type' => 'blob', 'max' => 52428800, 'min' => 0, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-05-23', 'endpointPrefix' => 'kinesisanalytics', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceAbbreviation' => 'Kinesis Analytics V2', 'serviceFullName' => 'Amazon Kinesis Analytics', 'serviceId' => 'Kinesis Analytics V2', 'signatureVersion' => 'v4', 'signingName' => 'kinesisanalytics', 'targetPrefix' => 'KinesisAnalytics_20180523', 'uid' => 'kinesisanalyticsv2-2018-05-23', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AddApplicationCloudWatchLoggingOption' => [ 'name' => 'AddApplicationCloudWatchLoggingOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationCloudWatchLoggingOptionRequest', ], 'output' => [ 'shape' => 'AddApplicationCloudWatchLoggingOptionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'AddApplicationInput' => [ 'name' => 'AddApplicationInput', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationInputRequest', ], 'output' => [ 'shape' => 'AddApplicationInputResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'CodeValidationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddApplicationInputProcessingConfiguration' => [ 'name' => 'AddApplicationInputProcessingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationInputProcessingConfigurationRequest', ], 'output' => [ 'shape' => 'AddApplicationInputProcessingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddApplicationOutput' => [ 'name' => 'AddApplicationOutput', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationOutputRequest', ], 'output' => [ 'shape' => 'AddApplicationOutputResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddApplicationReferenceDataSource' => [ 'name' => 'AddApplicationReferenceDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationReferenceDataSourceRequest', ], 'output' => [ 'shape' => 'AddApplicationReferenceDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'AddApplicationVpcConfiguration' => [ 'name' => 'AddApplicationVpcConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddApplicationVpcConfigurationRequest', ], 'output' => [ 'shape' => 'AddApplicationVpcConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'CreateApplication' => [ 'name' => 'CreateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateApplicationRequest', ], 'output' => [ 'shape' => 'CreateApplicationResponse', ], 'errors' => [ [ 'shape' => 'CodeValidationException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'CreateApplicationPresignedUrl' => [ 'name' => 'CreateApplicationPresignedUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateApplicationPresignedUrlRequest', ], 'output' => [ 'shape' => 'CreateApplicationPresignedUrlResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], ], ], 'CreateApplicationSnapshot' => [ 'name' => 'CreateApplicationSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateApplicationSnapshotRequest', ], 'output' => [ 'shape' => 'CreateApplicationSnapshotResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'DeleteApplication' => [ 'name' => 'DeleteApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationRequest', ], 'output' => [ 'shape' => 'DeleteApplicationResponse', ], 'errors' => [ [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'DeleteApplicationCloudWatchLoggingOption' => [ 'name' => 'DeleteApplicationCloudWatchLoggingOption', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationCloudWatchLoggingOptionRequest', ], 'output' => [ 'shape' => 'DeleteApplicationCloudWatchLoggingOptionResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'DeleteApplicationInputProcessingConfiguration' => [ 'name' => 'DeleteApplicationInputProcessingConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationInputProcessingConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteApplicationInputProcessingConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteApplicationOutput' => [ 'name' => 'DeleteApplicationOutput', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationOutputRequest', ], 'output' => [ 'shape' => 'DeleteApplicationOutputResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteApplicationReferenceDataSource' => [ 'name' => 'DeleteApplicationReferenceDataSource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationReferenceDataSourceRequest', ], 'output' => [ 'shape' => 'DeleteApplicationReferenceDataSourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DeleteApplicationSnapshot' => [ 'name' => 'DeleteApplicationSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteApplicationSnapshotResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'DeleteApplicationVpcConfiguration' => [ 'name' => 'DeleteApplicationVpcConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationVpcConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteApplicationVpcConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], ], ], 'DescribeApplication' => [ 'name' => 'DescribeApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeApplicationRequest', ], 'output' => [ 'shape' => 'DescribeApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'DescribeApplicationOperation' => [ 'name' => 'DescribeApplicationOperation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeApplicationOperationRequest', ], 'output' => [ 'shape' => 'DescribeApplicationOperationResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'DescribeApplicationSnapshot' => [ 'name' => 'DescribeApplicationSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeApplicationSnapshotRequest', ], 'output' => [ 'shape' => 'DescribeApplicationSnapshotResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'DescribeApplicationVersion' => [ 'name' => 'DescribeApplicationVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeApplicationVersionRequest', ], 'output' => [ 'shape' => 'DescribeApplicationVersionResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'DiscoverInputSchema' => [ 'name' => 'DiscoverInputSchema', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DiscoverInputSchemaRequest', ], 'output' => [ 'shape' => 'DiscoverInputSchemaResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnableToDetectSchemaException', ], [ 'shape' => 'ResourceProvisionedThroughputExceededException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'ListApplicationOperations' => [ 'name' => 'ListApplicationOperations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListApplicationOperationsRequest', ], 'output' => [ 'shape' => 'ListApplicationOperationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'ListApplicationSnapshots' => [ 'name' => 'ListApplicationSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListApplicationSnapshotsRequest', ], 'output' => [ 'shape' => 'ListApplicationSnapshotsResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'ListApplicationVersions' => [ 'name' => 'ListApplicationVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListApplicationVersionsRequest', ], 'output' => [ 'shape' => 'ListApplicationVersionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'ListApplications' => [ 'name' => 'ListApplications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListApplicationsRequest', ], 'output' => [ 'shape' => 'ListApplicationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'RollbackApplication' => [ 'name' => 'RollbackApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RollbackApplicationRequest', ], 'output' => [ 'shape' => 'RollbackApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], 'StartApplication' => [ 'name' => 'StartApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartApplicationRequest', ], 'output' => [ 'shape' => 'StartApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], [ 'shape' => 'InvalidRequestException', ], ], ], 'StopApplication' => [ 'name' => 'StopApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopApplicationRequest', ], 'output' => [ 'shape' => 'StopApplicationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], ], ], 'UpdateApplication' => [ 'name' => 'UpdateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateApplicationRequest', ], 'output' => [ 'shape' => 'UpdateApplicationResponse', ], 'errors' => [ [ 'shape' => 'CodeValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'InvalidApplicationConfigurationException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'UpdateApplicationMaintenanceConfiguration' => [ 'name' => 'UpdateApplicationMaintenanceConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateApplicationMaintenanceConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateApplicationMaintenanceConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'InvalidArgumentException', ], [ 'shape' => 'ConcurrentModificationException', ], [ 'shape' => 'UnsupportedOperationException', ], ], ], ], 'shapes' => [ 'AddApplicationCloudWatchLoggingOptionRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CloudWatchLoggingOption', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CloudWatchLoggingOption' => [ 'shape' => 'CloudWatchLoggingOption', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], ], ], 'AddApplicationCloudWatchLoggingOptionResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CloudWatchLoggingOptionDescriptions' => [ 'shape' => 'CloudWatchLoggingOptionDescriptions', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'AddApplicationInputProcessingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'InputId', 'InputProcessingConfiguration', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'InputId' => [ 'shape' => 'Id', ], 'InputProcessingConfiguration' => [ 'shape' => 'InputProcessingConfiguration', ], ], ], 'AddApplicationInputProcessingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'InputId' => [ 'shape' => 'Id', ], 'InputProcessingConfigurationDescription' => [ 'shape' => 'InputProcessingConfigurationDescription', ], ], ], 'AddApplicationInputRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'Input', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'Input' => [ 'shape' => 'Input', ], ], ], 'AddApplicationInputResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'InputDescriptions' => [ 'shape' => 'InputDescriptions', ], ], ], 'AddApplicationOutputRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'Output', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'Output' => [ 'shape' => 'Output', ], ], ], 'AddApplicationOutputResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'OutputDescriptions' => [ 'shape' => 'OutputDescriptions', ], ], ], 'AddApplicationReferenceDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'ReferenceDataSource', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ReferenceDataSource' => [ 'shape' => 'ReferenceDataSource', ], ], ], 'AddApplicationReferenceDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ReferenceDataSourceDescriptions' => [ 'shape' => 'ReferenceDataSourceDescriptions', ], ], ], 'AddApplicationVpcConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'VpcConfiguration', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'VpcConfiguration' => [ 'shape' => 'VpcConfiguration', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], ], ], 'AddApplicationVpcConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'VpcConfigurationDescription' => [ 'shape' => 'VpcConfigurationDescription', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'ApplicationCodeConfiguration' => [ 'type' => 'structure', 'required' => [ 'CodeContentType', ], 'members' => [ 'CodeContent' => [ 'shape' => 'CodeContent', ], 'CodeContentType' => [ 'shape' => 'CodeContentType', ], ], ], 'ApplicationCodeConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'CodeContentType', ], 'members' => [ 'CodeContentType' => [ 'shape' => 'CodeContentType', ], 'CodeContentDescription' => [ 'shape' => 'CodeContentDescription', ], ], ], 'ApplicationCodeConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'CodeContentTypeUpdate' => [ 'shape' => 'CodeContentType', ], 'CodeContentUpdate' => [ 'shape' => 'CodeContentUpdate', ], ], ], 'ApplicationConfiguration' => [ 'type' => 'structure', 'members' => [ 'SqlApplicationConfiguration' => [ 'shape' => 'SqlApplicationConfiguration', ], 'FlinkApplicationConfiguration' => [ 'shape' => 'FlinkApplicationConfiguration', ], 'EnvironmentProperties' => [ 'shape' => 'EnvironmentProperties', ], 'ApplicationCodeConfiguration' => [ 'shape' => 'ApplicationCodeConfiguration', ], 'ApplicationSnapshotConfiguration' => [ 'shape' => 'ApplicationSnapshotConfiguration', ], 'ApplicationSystemRollbackConfiguration' => [ 'shape' => 'ApplicationSystemRollbackConfiguration', ], 'VpcConfigurations' => [ 'shape' => 'VpcConfigurations', ], 'ZeppelinApplicationConfiguration' => [ 'shape' => 'ZeppelinApplicationConfiguration', ], ], ], 'ApplicationConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'SqlApplicationConfigurationDescription' => [ 'shape' => 'SqlApplicationConfigurationDescription', ], 'ApplicationCodeConfigurationDescription' => [ 'shape' => 'ApplicationCodeConfigurationDescription', ], 'RunConfigurationDescription' => [ 'shape' => 'RunConfigurationDescription', ], 'FlinkApplicationConfigurationDescription' => [ 'shape' => 'FlinkApplicationConfigurationDescription', ], 'EnvironmentPropertyDescriptions' => [ 'shape' => 'EnvironmentPropertyDescriptions', ], 'ApplicationSnapshotConfigurationDescription' => [ 'shape' => 'ApplicationSnapshotConfigurationDescription', ], 'ApplicationSystemRollbackConfigurationDescription' => [ 'shape' => 'ApplicationSystemRollbackConfigurationDescription', ], 'VpcConfigurationDescriptions' => [ 'shape' => 'VpcConfigurationDescriptions', ], 'ZeppelinApplicationConfigurationDescription' => [ 'shape' => 'ZeppelinApplicationConfigurationDescription', ], ], ], 'ApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'SqlApplicationConfigurationUpdate' => [ 'shape' => 'SqlApplicationConfigurationUpdate', ], 'ApplicationCodeConfigurationUpdate' => [ 'shape' => 'ApplicationCodeConfigurationUpdate', ], 'FlinkApplicationConfigurationUpdate' => [ 'shape' => 'FlinkApplicationConfigurationUpdate', ], 'EnvironmentPropertyUpdates' => [ 'shape' => 'EnvironmentPropertyUpdates', ], 'ApplicationSnapshotConfigurationUpdate' => [ 'shape' => 'ApplicationSnapshotConfigurationUpdate', ], 'ApplicationSystemRollbackConfigurationUpdate' => [ 'shape' => 'ApplicationSystemRollbackConfigurationUpdate', ], 'VpcConfigurationUpdates' => [ 'shape' => 'VpcConfigurationUpdates', ], 'ZeppelinApplicationConfigurationUpdate' => [ 'shape' => 'ZeppelinApplicationConfigurationUpdate', ], ], ], 'ApplicationDescription' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'ApplicationDetail' => [ 'type' => 'structure', 'required' => [ 'ApplicationARN', 'ApplicationName', 'RuntimeEnvironment', 'ApplicationStatus', 'ApplicationVersionId', ], 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationDescription' => [ 'shape' => 'ApplicationDescription', ], 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'RuntimeEnvironment' => [ 'shape' => 'RuntimeEnvironment', ], 'ServiceExecutionRole' => [ 'shape' => 'RoleARN', ], 'ApplicationStatus' => [ 'shape' => 'ApplicationStatus', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], 'LastUpdateTimestamp' => [ 'shape' => 'Timestamp', ], 'ApplicationConfigurationDescription' => [ 'shape' => 'ApplicationConfigurationDescription', ], 'CloudWatchLoggingOptionDescriptions' => [ 'shape' => 'CloudWatchLoggingOptionDescriptions', ], 'ApplicationMaintenanceConfigurationDescription' => [ 'shape' => 'ApplicationMaintenanceConfigurationDescription', ], 'ApplicationVersionUpdatedFrom' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationVersionRolledBackFrom' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationVersionCreateTimestamp' => [ 'shape' => 'Timestamp', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], 'ApplicationVersionRolledBackTo' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationMode' => [ 'shape' => 'ApplicationMode', ], ], ], 'ApplicationMaintenanceConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'ApplicationMaintenanceWindowStartTime', 'ApplicationMaintenanceWindowEndTime', ], 'members' => [ 'ApplicationMaintenanceWindowStartTime' => [ 'shape' => 'ApplicationMaintenanceWindowStartTime', ], 'ApplicationMaintenanceWindowEndTime' => [ 'shape' => 'ApplicationMaintenanceWindowEndTime', ], ], ], 'ApplicationMaintenanceConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'ApplicationMaintenanceWindowStartTimeUpdate', ], 'members' => [ 'ApplicationMaintenanceWindowStartTimeUpdate' => [ 'shape' => 'ApplicationMaintenanceWindowStartTime', ], ], ], 'ApplicationMaintenanceWindowEndTime' => [ 'type' => 'string', 'max' => 5, 'min' => 5, 'pattern' => '([01][0-9]|2[0-3]):[0-5][0-9]', ], 'ApplicationMaintenanceWindowStartTime' => [ 'type' => 'string', 'max' => 5, 'min' => 5, 'pattern' => '([01][0-9]|2[0-3]):[0-5][0-9]', ], 'ApplicationMode' => [ 'type' => 'string', 'enum' => [ 'STREAMING', 'INTERACTIVE', ], ], 'ApplicationName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'ApplicationOperationInfo' => [ 'type' => 'structure', 'members' => [ 'Operation' => [ 'shape' => 'Operation', ], 'OperationId' => [ 'shape' => 'OperationId', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'OperationStatus' => [ 'shape' => 'OperationStatus', ], ], ], 'ApplicationOperationInfoDetails' => [ 'type' => 'structure', 'required' => [ 'Operation', 'StartTime', 'EndTime', 'OperationStatus', ], 'members' => [ 'Operation' => [ 'shape' => 'Operation', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], 'OperationStatus' => [ 'shape' => 'OperationStatus', ], 'ApplicationVersionChangeDetails' => [ 'shape' => 'ApplicationVersionChangeDetails', ], 'OperationFailureDetails' => [ 'shape' => 'OperationFailureDetails', ], ], ], 'ApplicationOperationInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApplicationOperationInfo', ], ], 'ApplicationRestoreConfiguration' => [ 'type' => 'structure', 'required' => [ 'ApplicationRestoreType', ], 'members' => [ 'ApplicationRestoreType' => [ 'shape' => 'ApplicationRestoreType', ], 'SnapshotName' => [ 'shape' => 'SnapshotName', ], ], ], 'ApplicationRestoreType' => [ 'type' => 'string', 'enum' => [ 'SKIP_RESTORE_FROM_SNAPSHOT', 'RESTORE_FROM_LATEST_SNAPSHOT', 'RESTORE_FROM_CUSTOM_SNAPSHOT', ], ], 'ApplicationSnapshotConfiguration' => [ 'type' => 'structure', 'required' => [ 'SnapshotsEnabled', ], 'members' => [ 'SnapshotsEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationSnapshotConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'SnapshotsEnabled', ], 'members' => [ 'SnapshotsEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationSnapshotConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'SnapshotsEnabledUpdate', ], 'members' => [ 'SnapshotsEnabledUpdate' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationStatus' => [ 'type' => 'string', 'enum' => [ 'DELETING', 'STARTING', 'STOPPING', 'READY', 'RUNNING', 'UPDATING', 'AUTOSCALING', 'FORCE_STOPPING', 'ROLLING_BACK', 'MAINTENANCE', 'ROLLED_BACK', ], ], 'ApplicationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApplicationSummary', ], ], 'ApplicationSummary' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'ApplicationARN', 'ApplicationStatus', 'ApplicationVersionId', 'RuntimeEnvironment', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationStatus' => [ 'shape' => 'ApplicationStatus', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'RuntimeEnvironment' => [ 'shape' => 'RuntimeEnvironment', ], 'ApplicationMode' => [ 'shape' => 'ApplicationMode', ], ], ], 'ApplicationSystemRollbackConfiguration' => [ 'type' => 'structure', 'required' => [ 'RollbackEnabled', ], 'members' => [ 'RollbackEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationSystemRollbackConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'RollbackEnabled', ], 'members' => [ 'RollbackEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationSystemRollbackConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'RollbackEnabledUpdate', ], 'members' => [ 'RollbackEnabledUpdate' => [ 'shape' => 'BooleanObject', ], ], ], 'ApplicationVersionChangeDetails' => [ 'type' => 'structure', 'required' => [ 'ApplicationVersionUpdatedFrom', 'ApplicationVersionUpdatedTo', ], 'members' => [ 'ApplicationVersionUpdatedFrom' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationVersionUpdatedTo' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'ApplicationVersionId' => [ 'type' => 'long', 'max' => 999999999, 'min' => 1, ], 'ApplicationVersionSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApplicationVersionSummary', ], ], 'ApplicationVersionSummary' => [ 'type' => 'structure', 'required' => [ 'ApplicationVersionId', 'ApplicationStatus', ], 'members' => [ 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationStatus' => [ 'shape' => 'ApplicationStatus', ], ], ], 'ArtifactType' => [ 'type' => 'string', 'enum' => [ 'UDF', 'DEPENDENCY_JAR', ], ], 'AuthorizedUrl' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'BasePath' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[a-zA-Z0-9/!-_.*\'()]+', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'BucketARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'CSVMappingParameters' => [ 'type' => 'structure', 'required' => [ 'RecordRowDelimiter', 'RecordColumnDelimiter', ], 'members' => [ 'RecordRowDelimiter' => [ 'shape' => 'RecordRowDelimiter', ], 'RecordColumnDelimiter' => [ 'shape' => 'RecordColumnDelimiter', ], ], ], 'CatalogConfiguration' => [ 'type' => 'structure', 'required' => [ 'GlueDataCatalogConfiguration', ], 'members' => [ 'GlueDataCatalogConfiguration' => [ 'shape' => 'GlueDataCatalogConfiguration', ], ], ], 'CatalogConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'GlueDataCatalogConfigurationDescription', ], 'members' => [ 'GlueDataCatalogConfigurationDescription' => [ 'shape' => 'GlueDataCatalogConfigurationDescription', ], ], ], 'CatalogConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'GlueDataCatalogConfigurationUpdate', ], 'members' => [ 'GlueDataCatalogConfigurationUpdate' => [ 'shape' => 'GlueDataCatalogConfigurationUpdate', ], ], ], 'CheckpointConfiguration' => [ 'type' => 'structure', 'required' => [ 'ConfigurationType', ], 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'CheckpointingEnabled' => [ 'shape' => 'BooleanObject', ], 'CheckpointInterval' => [ 'shape' => 'CheckpointInterval', ], 'MinPauseBetweenCheckpoints' => [ 'shape' => 'MinPauseBetweenCheckpoints', ], ], ], 'CheckpointConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'CheckpointingEnabled' => [ 'shape' => 'BooleanObject', ], 'CheckpointInterval' => [ 'shape' => 'CheckpointInterval', ], 'MinPauseBetweenCheckpoints' => [ 'shape' => 'MinPauseBetweenCheckpoints', ], ], ], 'CheckpointConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'ConfigurationTypeUpdate' => [ 'shape' => 'ConfigurationType', ], 'CheckpointingEnabledUpdate' => [ 'shape' => 'BooleanObject', ], 'CheckpointIntervalUpdate' => [ 'shape' => 'CheckpointInterval', ], 'MinPauseBetweenCheckpointsUpdate' => [ 'shape' => 'MinPauseBetweenCheckpoints', ], ], ], 'CheckpointInterval' => [ 'type' => 'long', 'min' => 1, ], 'CloudWatchLoggingOption' => [ 'type' => 'structure', 'required' => [ 'LogStreamARN', ], 'members' => [ 'LogStreamARN' => [ 'shape' => 'LogStreamARN', ], ], ], 'CloudWatchLoggingOptionDescription' => [ 'type' => 'structure', 'required' => [ 'LogStreamARN', ], 'members' => [ 'CloudWatchLoggingOptionId' => [ 'shape' => 'Id', ], 'LogStreamARN' => [ 'shape' => 'LogStreamARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'CloudWatchLoggingOptionDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudWatchLoggingOptionDescription', ], ], 'CloudWatchLoggingOptionUpdate' => [ 'type' => 'structure', 'required' => [ 'CloudWatchLoggingOptionId', ], 'members' => [ 'CloudWatchLoggingOptionId' => [ 'shape' => 'Id', ], 'LogStreamARNUpdate' => [ 'shape' => 'LogStreamARN', ], ], ], 'CloudWatchLoggingOptionUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudWatchLoggingOptionUpdate', ], ], 'CloudWatchLoggingOptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'CloudWatchLoggingOption', ], ], 'CodeContent' => [ 'type' => 'structure', 'members' => [ 'TextContent' => [ 'shape' => 'TextContent', ], 'ZipFileContent' => [ 'shape' => 'ZipFileContent', ], 'S3ContentLocation' => [ 'shape' => 'S3ContentLocation', ], ], ], 'CodeContentDescription' => [ 'type' => 'structure', 'members' => [ 'TextContent' => [ 'shape' => 'TextContent', ], 'CodeMD5' => [ 'shape' => 'CodeMD5', ], 'CodeSize' => [ 'shape' => 'CodeSize', ], 'S3ApplicationCodeLocationDescription' => [ 'shape' => 'S3ApplicationCodeLocationDescription', ], ], ], 'CodeContentType' => [ 'type' => 'string', 'enum' => [ 'PLAINTEXT', 'ZIPFILE', ], ], 'CodeContentUpdate' => [ 'type' => 'structure', 'members' => [ 'TextContentUpdate' => [ 'shape' => 'TextContent', ], 'ZipFileContentUpdate' => [ 'shape' => 'ZipFileContent', ], 'S3ContentLocationUpdate' => [ 'shape' => 'S3ContentLocationUpdate', ], ], ], 'CodeMD5' => [ 'type' => 'string', 'max' => 128, 'min' => 128, ], 'CodeSize' => [ 'type' => 'long', 'max' => 52428800, 'min' => 0, ], 'CodeValidationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ConcurrentModificationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ConditionalToken' => [ 'type' => 'string', 'max' => 512, 'min' => 1, 'pattern' => '[a-zA-Z0-9-_+/=]+', ], 'ConfigurationType' => [ 'type' => 'string', 'enum' => [ 'DEFAULT', 'CUSTOM', ], ], 'CreateApplicationPresignedUrlRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'UrlType', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'UrlType' => [ 'shape' => 'UrlType', ], 'SessionExpirationDurationInSeconds' => [ 'shape' => 'SessionExpirationDurationInSeconds', ], ], ], 'CreateApplicationPresignedUrlResponse' => [ 'type' => 'structure', 'members' => [ 'AuthorizedUrl' => [ 'shape' => 'AuthorizedUrl', ], ], ], 'CreateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'RuntimeEnvironment', 'ServiceExecutionRole', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'ApplicationDescription' => [ 'shape' => 'ApplicationDescription', ], 'RuntimeEnvironment' => [ 'shape' => 'RuntimeEnvironment', ], 'ServiceExecutionRole' => [ 'shape' => 'RoleARN', ], 'ApplicationConfiguration' => [ 'shape' => 'ApplicationConfiguration', ], 'CloudWatchLoggingOptions' => [ 'shape' => 'CloudWatchLoggingOptions', ], 'Tags' => [ 'shape' => 'Tags', ], 'ApplicationMode' => [ 'shape' => 'ApplicationMode', ], ], ], 'CreateApplicationResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationDetail', ], 'members' => [ 'ApplicationDetail' => [ 'shape' => 'ApplicationDetail', ], ], ], 'CreateApplicationSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'SnapshotName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'SnapshotName' => [ 'shape' => 'SnapshotName', ], ], ], 'CreateApplicationSnapshotResponse' => [ 'type' => 'structure', 'members' => [], ], 'CustomArtifactConfiguration' => [ 'type' => 'structure', 'required' => [ 'ArtifactType', ], 'members' => [ 'ArtifactType' => [ 'shape' => 'ArtifactType', ], 'S3ContentLocation' => [ 'shape' => 'S3ContentLocation', ], 'MavenReference' => [ 'shape' => 'MavenReference', ], ], ], 'CustomArtifactConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ArtifactType' => [ 'shape' => 'ArtifactType', ], 'S3ContentLocationDescription' => [ 'shape' => 'S3ContentLocation', ], 'MavenReferenceDescription' => [ 'shape' => 'MavenReference', ], ], ], 'CustomArtifactsConfigurationDescriptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomArtifactConfigurationDescription', ], 'max' => 50, ], 'CustomArtifactsConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomArtifactConfiguration', ], 'max' => 50, ], 'DatabaseARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'DeleteApplicationCloudWatchLoggingOptionRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CloudWatchLoggingOptionId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CloudWatchLoggingOptionId' => [ 'shape' => 'Id', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], ], ], 'DeleteApplicationCloudWatchLoggingOptionResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'CloudWatchLoggingOptionDescriptions' => [ 'shape' => 'CloudWatchLoggingOptionDescriptions', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'DeleteApplicationInputProcessingConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'InputId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'InputId' => [ 'shape' => 'Id', ], ], ], 'DeleteApplicationInputProcessingConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'DeleteApplicationOutputRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'OutputId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'OutputId' => [ 'shape' => 'Id', ], ], ], 'DeleteApplicationOutputResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'DeleteApplicationReferenceDataSourceRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', 'ReferenceId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ReferenceId' => [ 'shape' => 'Id', ], ], ], 'DeleteApplicationReferenceDataSourceResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'DeleteApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CreateTimestamp', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CreateTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteApplicationSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'SnapshotName', 'SnapshotCreationTimestamp', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'SnapshotName' => [ 'shape' => 'SnapshotName', ], 'SnapshotCreationTimestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeleteApplicationSnapshotResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteApplicationVpcConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'VpcConfigurationId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'VpcConfigurationId' => [ 'shape' => 'Id', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], ], ], 'DeleteApplicationVpcConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'DeployAsApplicationConfiguration' => [ 'type' => 'structure', 'required' => [ 'S3ContentLocation', ], 'members' => [ 'S3ContentLocation' => [ 'shape' => 'S3ContentBaseLocation', ], ], ], 'DeployAsApplicationConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'S3ContentLocationDescription', ], 'members' => [ 'S3ContentLocationDescription' => [ 'shape' => 'S3ContentBaseLocationDescription', ], ], ], 'DeployAsApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'S3ContentLocationUpdate' => [ 'shape' => 'S3ContentBaseLocationUpdate', ], ], ], 'DescribeApplicationOperationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'OperationId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'DescribeApplicationOperationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationOperationInfoDetails' => [ 'shape' => 'ApplicationOperationInfoDetails', ], ], ], 'DescribeApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'IncludeAdditionalDetails' => [ 'shape' => 'BooleanObject', ], ], ], 'DescribeApplicationResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationDetail', ], 'members' => [ 'ApplicationDetail' => [ 'shape' => 'ApplicationDetail', ], ], ], 'DescribeApplicationSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'SnapshotName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'SnapshotName' => [ 'shape' => 'SnapshotName', ], ], ], 'DescribeApplicationSnapshotResponse' => [ 'type' => 'structure', 'required' => [ 'SnapshotDetails', ], 'members' => [ 'SnapshotDetails' => [ 'shape' => 'SnapshotDetails', ], ], ], 'DescribeApplicationVersionRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'ApplicationVersionId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'DescribeApplicationVersionResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationVersionDetail' => [ 'shape' => 'ApplicationDetail', ], ], ], 'DestinationSchema' => [ 'type' => 'structure', 'required' => [ 'RecordFormatType', ], 'members' => [ 'RecordFormatType' => [ 'shape' => 'RecordFormatType', ], ], ], 'DiscoverInputSchemaRequest' => [ 'type' => 'structure', 'required' => [ 'ServiceExecutionRole', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'ServiceExecutionRole' => [ 'shape' => 'RoleARN', ], 'InputStartingPositionConfiguration' => [ 'shape' => 'InputStartingPositionConfiguration', ], 'S3Configuration' => [ 'shape' => 'S3Configuration', ], 'InputProcessingConfiguration' => [ 'shape' => 'InputProcessingConfiguration', ], ], ], 'DiscoverInputSchemaResponse' => [ 'type' => 'structure', 'members' => [ 'InputSchema' => [ 'shape' => 'SourceSchema', ], 'ParsedInputRecords' => [ 'shape' => 'ParsedInputRecords', ], 'ProcessedInputRecords' => [ 'shape' => 'ProcessedInputRecords', ], 'RawInputRecords' => [ 'shape' => 'RawInputRecords', ], ], ], 'EnvironmentProperties' => [ 'type' => 'structure', 'required' => [ 'PropertyGroups', ], 'members' => [ 'PropertyGroups' => [ 'shape' => 'PropertyGroups', ], ], ], 'EnvironmentPropertyDescriptions' => [ 'type' => 'structure', 'members' => [ 'PropertyGroupDescriptions' => [ 'shape' => 'PropertyGroups', ], ], ], 'EnvironmentPropertyUpdates' => [ 'type' => 'structure', 'required' => [ 'PropertyGroups', ], 'members' => [ 'PropertyGroups' => [ 'shape' => 'PropertyGroups', ], ], ], 'ErrorInfo' => [ 'type' => 'structure', 'members' => [ 'ErrorString' => [ 'shape' => 'ErrorString', ], ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'ErrorString' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'FileKey' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'FlinkApplicationConfiguration' => [ 'type' => 'structure', 'members' => [ 'CheckpointConfiguration' => [ 'shape' => 'CheckpointConfiguration', ], 'MonitoringConfiguration' => [ 'shape' => 'MonitoringConfiguration', ], 'ParallelismConfiguration' => [ 'shape' => 'ParallelismConfiguration', ], ], ], 'FlinkApplicationConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'CheckpointConfigurationDescription' => [ 'shape' => 'CheckpointConfigurationDescription', ], 'MonitoringConfigurationDescription' => [ 'shape' => 'MonitoringConfigurationDescription', ], 'ParallelismConfigurationDescription' => [ 'shape' => 'ParallelismConfigurationDescription', ], 'JobPlanDescription' => [ 'shape' => 'JobPlanDescription', ], ], ], 'FlinkApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'CheckpointConfigurationUpdate' => [ 'shape' => 'CheckpointConfigurationUpdate', ], 'MonitoringConfigurationUpdate' => [ 'shape' => 'MonitoringConfigurationUpdate', ], 'ParallelismConfigurationUpdate' => [ 'shape' => 'ParallelismConfigurationUpdate', ], ], ], 'FlinkRunConfiguration' => [ 'type' => 'structure', 'members' => [ 'AllowNonRestoredState' => [ 'shape' => 'BooleanObject', ], ], ], 'GlueDataCatalogConfiguration' => [ 'type' => 'structure', 'required' => [ 'DatabaseARN', ], 'members' => [ 'DatabaseARN' => [ 'shape' => 'DatabaseARN', ], ], ], 'GlueDataCatalogConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'DatabaseARN', ], 'members' => [ 'DatabaseARN' => [ 'shape' => 'DatabaseARN', ], ], ], 'GlueDataCatalogConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'DatabaseARNUpdate', ], 'members' => [ 'DatabaseARNUpdate' => [ 'shape' => 'DatabaseARN', ], ], ], 'Id' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'InAppStreamName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[^-\\s<>&]*', ], 'InAppStreamNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'InAppStreamName', ], ], 'InAppTableName' => [ 'type' => 'string', 'max' => 32, 'min' => 1, ], 'Input' => [ 'type' => 'structure', 'required' => [ 'NamePrefix', 'InputSchema', ], 'members' => [ 'NamePrefix' => [ 'shape' => 'InAppStreamName', ], 'InputProcessingConfiguration' => [ 'shape' => 'InputProcessingConfiguration', ], 'KinesisStreamsInput' => [ 'shape' => 'KinesisStreamsInput', ], 'KinesisFirehoseInput' => [ 'shape' => 'KinesisFirehoseInput', ], 'InputParallelism' => [ 'shape' => 'InputParallelism', ], 'InputSchema' => [ 'shape' => 'SourceSchema', ], ], ], 'InputDescription' => [ 'type' => 'structure', 'members' => [ 'InputId' => [ 'shape' => 'Id', ], 'NamePrefix' => [ 'shape' => 'InAppStreamName', ], 'InAppStreamNames' => [ 'shape' => 'InAppStreamNames', ], 'InputProcessingConfigurationDescription' => [ 'shape' => 'InputProcessingConfigurationDescription', ], 'KinesisStreamsInputDescription' => [ 'shape' => 'KinesisStreamsInputDescription', ], 'KinesisFirehoseInputDescription' => [ 'shape' => 'KinesisFirehoseInputDescription', ], 'InputSchema' => [ 'shape' => 'SourceSchema', ], 'InputParallelism' => [ 'shape' => 'InputParallelism', ], 'InputStartingPositionConfiguration' => [ 'shape' => 'InputStartingPositionConfiguration', ], ], ], 'InputDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputDescription', ], ], 'InputLambdaProcessor' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'InputLambdaProcessorDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'InputLambdaProcessorUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'InputParallelism' => [ 'type' => 'structure', 'members' => [ 'Count' => [ 'shape' => 'InputParallelismCount', ], ], ], 'InputParallelismCount' => [ 'type' => 'integer', 'max' => 64, 'min' => 1, ], 'InputParallelismUpdate' => [ 'type' => 'structure', 'required' => [ 'CountUpdate', ], 'members' => [ 'CountUpdate' => [ 'shape' => 'InputParallelismCount', ], ], ], 'InputProcessingConfiguration' => [ 'type' => 'structure', 'required' => [ 'InputLambdaProcessor', ], 'members' => [ 'InputLambdaProcessor' => [ 'shape' => 'InputLambdaProcessor', ], ], ], 'InputProcessingConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'InputLambdaProcessorDescription' => [ 'shape' => 'InputLambdaProcessorDescription', ], ], ], 'InputProcessingConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'InputLambdaProcessorUpdate', ], 'members' => [ 'InputLambdaProcessorUpdate' => [ 'shape' => 'InputLambdaProcessorUpdate', ], ], ], 'InputSchemaUpdate' => [ 'type' => 'structure', 'members' => [ 'RecordFormatUpdate' => [ 'shape' => 'RecordFormat', ], 'RecordEncodingUpdate' => [ 'shape' => 'RecordEncoding', ], 'RecordColumnUpdates' => [ 'shape' => 'RecordColumns', ], ], ], 'InputStartingPosition' => [ 'type' => 'string', 'enum' => [ 'NOW', 'TRIM_HORIZON', 'LAST_STOPPED_POINT', ], ], 'InputStartingPositionConfiguration' => [ 'type' => 'structure', 'members' => [ 'InputStartingPosition' => [ 'shape' => 'InputStartingPosition', ], ], ], 'InputUpdate' => [ 'type' => 'structure', 'required' => [ 'InputId', ], 'members' => [ 'InputId' => [ 'shape' => 'Id', ], 'NamePrefixUpdate' => [ 'shape' => 'InAppStreamName', ], 'InputProcessingConfigurationUpdate' => [ 'shape' => 'InputProcessingConfigurationUpdate', ], 'KinesisStreamsInputUpdate' => [ 'shape' => 'KinesisStreamsInputUpdate', ], 'KinesisFirehoseInputUpdate' => [ 'shape' => 'KinesisFirehoseInputUpdate', ], 'InputSchemaUpdate' => [ 'shape' => 'InputSchemaUpdate', ], 'InputParallelismUpdate' => [ 'shape' => 'InputParallelismUpdate', ], ], ], 'InputUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'InputUpdate', ], ], 'Inputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Input', ], ], 'InvalidApplicationConfigurationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidArgumentException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'JSONMappingParameters' => [ 'type' => 'structure', 'required' => [ 'RecordRowPath', ], 'members' => [ 'RecordRowPath' => [ 'shape' => 'RecordRowPath', ], ], ], 'JobPlanDescription' => [ 'type' => 'string', ], 'KinesisAnalyticsARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'KinesisFirehoseInput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisFirehoseInputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'KinesisFirehoseInputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisFirehoseOutput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisFirehoseOutputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'KinesisFirehoseOutputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisStreamsInput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisStreamsInputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'KinesisStreamsInputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisStreamsOutput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'KinesisStreamsOutputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'KinesisStreamsOutputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'LambdaOutput' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], ], ], 'LambdaOutputDescription' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'ResourceARN', ], 'RoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'LambdaOutputUpdate' => [ 'type' => 'structure', 'required' => [ 'ResourceARNUpdate', ], 'members' => [ 'ResourceARNUpdate' => [ 'shape' => 'ResourceARN', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ListApplicationOperationsInputLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListApplicationOperationsRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'Limit' => [ 'shape' => 'ListApplicationOperationsInputLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'Operation' => [ 'shape' => 'Operation', ], 'OperationStatus' => [ 'shape' => 'OperationStatus', ], ], ], 'ListApplicationOperationsResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationOperationInfoList' => [ 'shape' => 'ApplicationOperationInfoList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationSnapshotsRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'Limit' => [ 'shape' => 'ListSnapshotsInputLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationSnapshotsResponse' => [ 'type' => 'structure', 'members' => [ 'SnapshotSummaries' => [ 'shape' => 'SnapshotSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationVersionsInputLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListApplicationVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'Limit' => [ 'shape' => 'ListApplicationVersionsInputLimit', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationVersionSummaries' => [ 'shape' => 'ApplicationVersionSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListApplicationsInputLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListApplicationsRequest' => [ 'type' => 'structure', 'members' => [ 'Limit' => [ 'shape' => 'ListApplicationsInputLimit', ], 'NextToken' => [ 'shape' => 'ApplicationName', ], ], ], 'ListApplicationsResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationSummaries', ], 'members' => [ 'ApplicationSummaries' => [ 'shape' => 'ApplicationSummaries', ], 'NextToken' => [ 'shape' => 'ApplicationName', ], ], ], 'ListSnapshotsInputLimit' => [ 'type' => 'integer', 'max' => 50, 'min' => 1, ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'KinesisAnalyticsARN', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'Tags', ], ], ], 'LogLevel' => [ 'type' => 'string', 'enum' => [ 'INFO', 'WARN', 'ERROR', 'DEBUG', ], ], 'LogStreamARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'MappingParameters' => [ 'type' => 'structure', 'members' => [ 'JSONMappingParameters' => [ 'shape' => 'JSONMappingParameters', ], 'CSVMappingParameters' => [ 'shape' => 'CSVMappingParameters', ], ], ], 'MavenArtifactId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'MavenGroupId' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'MavenReference' => [ 'type' => 'structure', 'required' => [ 'GroupId', 'ArtifactId', 'Version', ], 'members' => [ 'GroupId' => [ 'shape' => 'MavenGroupId', ], 'ArtifactId' => [ 'shape' => 'MavenArtifactId', ], 'Version' => [ 'shape' => 'MavenVersion', ], ], ], 'MavenVersion' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'MetricsLevel' => [ 'type' => 'string', 'enum' => [ 'APPLICATION', 'TASK', 'OPERATOR', 'PARALLELISM', ], ], 'MinPauseBetweenCheckpoints' => [ 'type' => 'long', 'min' => 0, ], 'MonitoringConfiguration' => [ 'type' => 'structure', 'required' => [ 'ConfigurationType', ], 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'MetricsLevel' => [ 'shape' => 'MetricsLevel', ], 'LogLevel' => [ 'shape' => 'LogLevel', ], ], ], 'MonitoringConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'MetricsLevel' => [ 'shape' => 'MetricsLevel', ], 'LogLevel' => [ 'shape' => 'LogLevel', ], ], ], 'MonitoringConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'ConfigurationTypeUpdate' => [ 'shape' => 'ConfigurationType', ], 'MetricsLevelUpdate' => [ 'shape' => 'MetricsLevel', ], 'LogLevelUpdate' => [ 'shape' => 'LogLevel', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 512, 'min' => 1, ], 'ObjectVersion' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'Operation' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'OperationFailureDetails' => [ 'type' => 'structure', 'members' => [ 'RollbackOperationId' => [ 'shape' => 'OperationId', ], 'ErrorInfo' => [ 'shape' => 'ErrorInfo', ], ], ], 'OperationId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'OperationStatus' => [ 'type' => 'string', 'enum' => [ 'IN_PROGRESS', 'CANCELLED', 'SUCCESSFUL', 'FAILED', ], ], 'Output' => [ 'type' => 'structure', 'required' => [ 'Name', 'DestinationSchema', ], 'members' => [ 'Name' => [ 'shape' => 'InAppStreamName', ], 'KinesisStreamsOutput' => [ 'shape' => 'KinesisStreamsOutput', ], 'KinesisFirehoseOutput' => [ 'shape' => 'KinesisFirehoseOutput', ], 'LambdaOutput' => [ 'shape' => 'LambdaOutput', ], 'DestinationSchema' => [ 'shape' => 'DestinationSchema', ], ], ], 'OutputDescription' => [ 'type' => 'structure', 'members' => [ 'OutputId' => [ 'shape' => 'Id', ], 'Name' => [ 'shape' => 'InAppStreamName', ], 'KinesisStreamsOutputDescription' => [ 'shape' => 'KinesisStreamsOutputDescription', ], 'KinesisFirehoseOutputDescription' => [ 'shape' => 'KinesisFirehoseOutputDescription', ], 'LambdaOutputDescription' => [ 'shape' => 'LambdaOutputDescription', ], 'DestinationSchema' => [ 'shape' => 'DestinationSchema', ], ], ], 'OutputDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputDescription', ], ], 'OutputUpdate' => [ 'type' => 'structure', 'required' => [ 'OutputId', ], 'members' => [ 'OutputId' => [ 'shape' => 'Id', ], 'NameUpdate' => [ 'shape' => 'InAppStreamName', ], 'KinesisStreamsOutputUpdate' => [ 'shape' => 'KinesisStreamsOutputUpdate', ], 'KinesisFirehoseOutputUpdate' => [ 'shape' => 'KinesisFirehoseOutputUpdate', ], 'LambdaOutputUpdate' => [ 'shape' => 'LambdaOutputUpdate', ], 'DestinationSchemaUpdate' => [ 'shape' => 'DestinationSchema', ], ], ], 'OutputUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'OutputUpdate', ], ], 'Outputs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Output', ], ], 'Parallelism' => [ 'type' => 'integer', 'min' => 1, ], 'ParallelismConfiguration' => [ 'type' => 'structure', 'required' => [ 'ConfigurationType', ], 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'Parallelism' => [ 'shape' => 'Parallelism', ], 'ParallelismPerKPU' => [ 'shape' => 'ParallelismPerKPU', ], 'AutoScalingEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ParallelismConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ConfigurationType' => [ 'shape' => 'ConfigurationType', ], 'Parallelism' => [ 'shape' => 'Parallelism', ], 'ParallelismPerKPU' => [ 'shape' => 'ParallelismPerKPU', ], 'CurrentParallelism' => [ 'shape' => 'Parallelism', ], 'AutoScalingEnabled' => [ 'shape' => 'BooleanObject', ], ], ], 'ParallelismConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'ConfigurationTypeUpdate' => [ 'shape' => 'ConfigurationType', ], 'ParallelismUpdate' => [ 'shape' => 'Parallelism', ], 'ParallelismPerKPUUpdate' => [ 'shape' => 'ParallelismPerKPU', ], 'AutoScalingEnabledUpdate' => [ 'shape' => 'BooleanObject', ], ], ], 'ParallelismPerKPU' => [ 'type' => 'integer', 'min' => 1, ], 'ParsedInputRecord' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParsedInputRecordField', ], ], 'ParsedInputRecordField' => [ 'type' => 'string', ], 'ParsedInputRecords' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParsedInputRecord', ], ], 'ProcessedInputRecord' => [ 'type' => 'string', ], 'ProcessedInputRecords' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessedInputRecord', ], ], 'PropertyGroup' => [ 'type' => 'structure', 'required' => [ 'PropertyGroupId', 'PropertyMap', ], 'members' => [ 'PropertyGroupId' => [ 'shape' => 'Id', ], 'PropertyMap' => [ 'shape' => 'PropertyMap', ], ], ], 'PropertyGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'PropertyGroup', ], 'max' => 50, ], 'PropertyKey' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'PropertyMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'PropertyKey', ], 'value' => [ 'shape' => 'PropertyValue', ], 'max' => 50, 'min' => 1, ], 'PropertyValue' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, ], 'RawInputRecord' => [ 'type' => 'string', ], 'RawInputRecords' => [ 'type' => 'list', 'member' => [ 'shape' => 'RawInputRecord', ], ], 'RecordColumn' => [ 'type' => 'structure', 'required' => [ 'Name', 'SqlType', ], 'members' => [ 'Name' => [ 'shape' => 'RecordColumnName', ], 'Mapping' => [ 'shape' => 'RecordColumnMapping', ], 'SqlType' => [ 'shape' => 'RecordColumnSqlType', ], ], ], 'RecordColumnDelimiter' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'RecordColumnMapping' => [ 'type' => 'string', 'max' => 65535, 'min' => 0, ], 'RecordColumnName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[^-\\s<>&]*', ], 'RecordColumnSqlType' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'RecordColumns' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecordColumn', ], 'max' => 1000, 'min' => 1, ], 'RecordEncoding' => [ 'type' => 'string', 'max' => 5, 'min' => 5, 'pattern' => 'UTF-8', ], 'RecordFormat' => [ 'type' => 'structure', 'required' => [ 'RecordFormatType', ], 'members' => [ 'RecordFormatType' => [ 'shape' => 'RecordFormatType', ], 'MappingParameters' => [ 'shape' => 'MappingParameters', ], ], ], 'RecordFormatType' => [ 'type' => 'string', 'enum' => [ 'JSON', 'CSV', ], ], 'RecordRowDelimiter' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'RecordRowPath' => [ 'type' => 'string', 'max' => 65535, 'min' => 1, 'pattern' => '^(?=^\\$)(?=^\\S+$).*$', ], 'ReferenceDataSource' => [ 'type' => 'structure', 'required' => [ 'TableName', 'ReferenceSchema', ], 'members' => [ 'TableName' => [ 'shape' => 'InAppTableName', ], 'S3ReferenceDataSource' => [ 'shape' => 'S3ReferenceDataSource', ], 'ReferenceSchema' => [ 'shape' => 'SourceSchema', ], ], ], 'ReferenceDataSourceDescription' => [ 'type' => 'structure', 'required' => [ 'ReferenceId', 'TableName', 'S3ReferenceDataSourceDescription', ], 'members' => [ 'ReferenceId' => [ 'shape' => 'Id', ], 'TableName' => [ 'shape' => 'InAppTableName', ], 'S3ReferenceDataSourceDescription' => [ 'shape' => 'S3ReferenceDataSourceDescription', ], 'ReferenceSchema' => [ 'shape' => 'SourceSchema', ], ], ], 'ReferenceDataSourceDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceDataSourceDescription', ], ], 'ReferenceDataSourceUpdate' => [ 'type' => 'structure', 'required' => [ 'ReferenceId', ], 'members' => [ 'ReferenceId' => [ 'shape' => 'Id', ], 'TableNameUpdate' => [ 'shape' => 'InAppTableName', ], 'S3ReferenceDataSourceUpdate' => [ 'shape' => 'S3ReferenceDataSourceUpdate', ], 'ReferenceSchemaUpdate' => [ 'shape' => 'SourceSchema', ], ], ], 'ReferenceDataSourceUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceDataSourceUpdate', ], ], 'ReferenceDataSources' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReferenceDataSource', ], ], 'ResourceARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'ResourceProvisionedThroughputExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'RoleARN' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => 'arn:.*', ], 'RollbackApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'CurrentApplicationVersionId', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], ], ], 'RollbackApplicationResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationDetail', ], 'members' => [ 'ApplicationDetail' => [ 'shape' => 'ApplicationDetail', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'RunConfiguration' => [ 'type' => 'structure', 'members' => [ 'FlinkRunConfiguration' => [ 'shape' => 'FlinkRunConfiguration', ], 'SqlRunConfigurations' => [ 'shape' => 'SqlRunConfigurations', ], 'ApplicationRestoreConfiguration' => [ 'shape' => 'ApplicationRestoreConfiguration', ], ], ], 'RunConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'ApplicationRestoreConfigurationDescription' => [ 'shape' => 'ApplicationRestoreConfiguration', ], 'FlinkRunConfigurationDescription' => [ 'shape' => 'FlinkRunConfiguration', ], ], ], 'RunConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'FlinkRunConfiguration' => [ 'shape' => 'FlinkRunConfiguration', ], 'ApplicationRestoreConfiguration' => [ 'shape' => 'ApplicationRestoreConfiguration', ], ], ], 'RuntimeEnvironment' => [ 'type' => 'string', 'enum' => [ 'SQL-1_0', 'FLINK-1_6', 'FLINK-1_8', 'ZEPPELIN-FLINK-1_0', 'FLINK-1_11', 'FLINK-1_13', 'ZEPPELIN-FLINK-2_0', 'FLINK-1_15', 'ZEPPELIN-FLINK-3_0', 'FLINK-1_18', 'FLINK-1_19', ], ], 'S3ApplicationCodeLocationDescription' => [ 'type' => 'structure', 'required' => [ 'BucketARN', 'FileKey', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], 'ObjectVersion' => [ 'shape' => 'ObjectVersion', ], ], ], 'S3Configuration' => [ 'type' => 'structure', 'required' => [ 'BucketARN', 'FileKey', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], ], ], 'S3ContentBaseLocation' => [ 'type' => 'structure', 'required' => [ 'BucketARN', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'BasePath' => [ 'shape' => 'BasePath', ], ], ], 'S3ContentBaseLocationDescription' => [ 'type' => 'structure', 'required' => [ 'BucketARN', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'BasePath' => [ 'shape' => 'BasePath', ], ], ], 'S3ContentBaseLocationUpdate' => [ 'type' => 'structure', 'members' => [ 'BucketARNUpdate' => [ 'shape' => 'BucketARN', ], 'BasePathUpdate' => [ 'shape' => 'BasePath', ], ], ], 'S3ContentLocation' => [ 'type' => 'structure', 'required' => [ 'BucketARN', 'FileKey', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], 'ObjectVersion' => [ 'shape' => 'ObjectVersion', ], ], ], 'S3ContentLocationUpdate' => [ 'type' => 'structure', 'members' => [ 'BucketARNUpdate' => [ 'shape' => 'BucketARN', ], 'FileKeyUpdate' => [ 'shape' => 'FileKey', ], 'ObjectVersionUpdate' => [ 'shape' => 'ObjectVersion', ], ], ], 'S3ReferenceDataSource' => [ 'type' => 'structure', 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], ], ], 'S3ReferenceDataSourceDescription' => [ 'type' => 'structure', 'required' => [ 'BucketARN', 'FileKey', ], 'members' => [ 'BucketARN' => [ 'shape' => 'BucketARN', ], 'FileKey' => [ 'shape' => 'FileKey', ], 'ReferenceRoleARN' => [ 'shape' => 'RoleARN', ], ], ], 'S3ReferenceDataSourceUpdate' => [ 'type' => 'structure', 'members' => [ 'BucketARNUpdate' => [ 'shape' => 'BucketARN', ], 'FileKeyUpdate' => [ 'shape' => 'FileKey', ], ], ], 'SecurityGroupId' => [ 'type' => 'string', ], 'SecurityGroupIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupId', ], 'max' => 5, 'min' => 1, ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, 'fault' => true, ], 'SessionExpirationDurationInSeconds' => [ 'type' => 'long', 'max' => 43200, 'min' => 1800, ], 'SnapshotDetails' => [ 'type' => 'structure', 'required' => [ 'SnapshotName', 'SnapshotStatus', 'ApplicationVersionId', ], 'members' => [ 'SnapshotName' => [ 'shape' => 'SnapshotName', ], 'SnapshotStatus' => [ 'shape' => 'SnapshotStatus', ], 'ApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'SnapshotCreationTimestamp' => [ 'shape' => 'Timestamp', ], 'RuntimeEnvironment' => [ 'shape' => 'RuntimeEnvironment', ], ], ], 'SnapshotName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9_.-]+', ], 'SnapshotStatus' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'READY', 'DELETING', 'FAILED', ], ], 'SnapshotSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'SnapshotDetails', ], ], 'SourceSchema' => [ 'type' => 'structure', 'required' => [ 'RecordFormat', 'RecordColumns', ], 'members' => [ 'RecordFormat' => [ 'shape' => 'RecordFormat', ], 'RecordEncoding' => [ 'shape' => 'RecordEncoding', ], 'RecordColumns' => [ 'shape' => 'RecordColumns', ], ], ], 'SqlApplicationConfiguration' => [ 'type' => 'structure', 'members' => [ 'Inputs' => [ 'shape' => 'Inputs', ], 'Outputs' => [ 'shape' => 'Outputs', ], 'ReferenceDataSources' => [ 'shape' => 'ReferenceDataSources', ], ], ], 'SqlApplicationConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'InputDescriptions' => [ 'shape' => 'InputDescriptions', ], 'OutputDescriptions' => [ 'shape' => 'OutputDescriptions', ], 'ReferenceDataSourceDescriptions' => [ 'shape' => 'ReferenceDataSourceDescriptions', ], ], ], 'SqlApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'InputUpdates' => [ 'shape' => 'InputUpdates', ], 'OutputUpdates' => [ 'shape' => 'OutputUpdates', ], 'ReferenceDataSourceUpdates' => [ 'shape' => 'ReferenceDataSourceUpdates', ], ], ], 'SqlRunConfiguration' => [ 'type' => 'structure', 'required' => [ 'InputId', 'InputStartingPositionConfiguration', ], 'members' => [ 'InputId' => [ 'shape' => 'Id', ], 'InputStartingPositionConfiguration' => [ 'shape' => 'InputStartingPositionConfiguration', ], ], ], 'SqlRunConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'SqlRunConfiguration', ], ], 'StartApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'RunConfiguration' => [ 'shape' => 'RunConfiguration', ], ], ], 'StartApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'StopApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'Force' => [ 'shape' => 'BooleanObject', ], ], ], 'StopApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'SubnetId' => [ 'type' => 'string', ], 'SubnetIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetId', ], 'max' => 16, 'min' => 1, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeys' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'Tags', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'KinesisAnalyticsARN', ], 'Tags' => [ 'shape' => 'Tags', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'Tags' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 200, 'min' => 1, ], 'TextContent' => [ 'type' => 'string', 'max' => 102400, 'min' => 0, ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'UnableToDetectSchemaException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], 'RawInputRecords' => [ 'shape' => 'RawInputRecords', ], 'ProcessedInputRecords' => [ 'shape' => 'ProcessedInputRecords', ], ], 'exception' => true, ], 'UnsupportedOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'TagKeys', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'KinesisAnalyticsARN', ], 'TagKeys' => [ 'shape' => 'TagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateApplicationMaintenanceConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', 'ApplicationMaintenanceConfigurationUpdate', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'ApplicationMaintenanceConfigurationUpdate' => [ 'shape' => 'ApplicationMaintenanceConfigurationUpdate', ], ], ], 'UpdateApplicationMaintenanceConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'ApplicationARN' => [ 'shape' => 'ResourceARN', ], 'ApplicationMaintenanceConfigurationDescription' => [ 'shape' => 'ApplicationMaintenanceConfigurationDescription', ], ], ], 'UpdateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'ApplicationName', ], 'members' => [ 'ApplicationName' => [ 'shape' => 'ApplicationName', ], 'CurrentApplicationVersionId' => [ 'shape' => 'ApplicationVersionId', ], 'ApplicationConfigurationUpdate' => [ 'shape' => 'ApplicationConfigurationUpdate', ], 'ServiceExecutionRoleUpdate' => [ 'shape' => 'RoleARN', ], 'RunConfigurationUpdate' => [ 'shape' => 'RunConfigurationUpdate', ], 'CloudWatchLoggingOptionUpdates' => [ 'shape' => 'CloudWatchLoggingOptionUpdates', ], 'ConditionalToken' => [ 'shape' => 'ConditionalToken', ], 'RuntimeEnvironmentUpdate' => [ 'shape' => 'RuntimeEnvironment', ], ], ], 'UpdateApplicationResponse' => [ 'type' => 'structure', 'required' => [ 'ApplicationDetail', ], 'members' => [ 'ApplicationDetail' => [ 'shape' => 'ApplicationDetail', ], 'OperationId' => [ 'shape' => 'OperationId', ], ], ], 'UrlType' => [ 'type' => 'string', 'enum' => [ 'FLINK_DASHBOARD_URL', 'ZEPPELIN_UI_URL', ], ], 'VpcConfiguration' => [ 'type' => 'structure', 'required' => [ 'SubnetIds', 'SecurityGroupIds', ], 'members' => [ 'SubnetIds' => [ 'shape' => 'SubnetIds', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], ], ], 'VpcConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'VpcConfigurationId', 'VpcId', 'SubnetIds', 'SecurityGroupIds', ], 'members' => [ 'VpcConfigurationId' => [ 'shape' => 'Id', ], 'VpcId' => [ 'shape' => 'VpcId', ], 'SubnetIds' => [ 'shape' => 'SubnetIds', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIds', ], ], ], 'VpcConfigurationDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcConfigurationDescription', ], ], 'VpcConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'VpcConfigurationId', ], 'members' => [ 'VpcConfigurationId' => [ 'shape' => 'Id', ], 'SubnetIdUpdates' => [ 'shape' => 'SubnetIds', ], 'SecurityGroupIdUpdates' => [ 'shape' => 'SecurityGroupIds', ], ], ], 'VpcConfigurationUpdates' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcConfigurationUpdate', ], ], 'VpcConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'VpcConfiguration', ], ], 'VpcId' => [ 'type' => 'string', ], 'ZeppelinApplicationConfiguration' => [ 'type' => 'structure', 'members' => [ 'MonitoringConfiguration' => [ 'shape' => 'ZeppelinMonitoringConfiguration', ], 'CatalogConfiguration' => [ 'shape' => 'CatalogConfiguration', ], 'DeployAsApplicationConfiguration' => [ 'shape' => 'DeployAsApplicationConfiguration', ], 'CustomArtifactsConfiguration' => [ 'shape' => 'CustomArtifactsConfigurationList', ], ], ], 'ZeppelinApplicationConfigurationDescription' => [ 'type' => 'structure', 'required' => [ 'MonitoringConfigurationDescription', ], 'members' => [ 'MonitoringConfigurationDescription' => [ 'shape' => 'ZeppelinMonitoringConfigurationDescription', ], 'CatalogConfigurationDescription' => [ 'shape' => 'CatalogConfigurationDescription', ], 'DeployAsApplicationConfigurationDescription' => [ 'shape' => 'DeployAsApplicationConfigurationDescription', ], 'CustomArtifactsConfigurationDescription' => [ 'shape' => 'CustomArtifactsConfigurationDescriptionList', ], ], ], 'ZeppelinApplicationConfigurationUpdate' => [ 'type' => 'structure', 'members' => [ 'MonitoringConfigurationUpdate' => [ 'shape' => 'ZeppelinMonitoringConfigurationUpdate', ], 'CatalogConfigurationUpdate' => [ 'shape' => 'CatalogConfigurationUpdate', ], 'DeployAsApplicationConfigurationUpdate' => [ 'shape' => 'DeployAsApplicationConfigurationUpdate', ], 'CustomArtifactsConfigurationUpdate' => [ 'shape' => 'CustomArtifactsConfigurationList', ], ], ], 'ZeppelinMonitoringConfiguration' => [ 'type' => 'structure', 'required' => [ 'LogLevel', ], 'members' => [ 'LogLevel' => [ 'shape' => 'LogLevel', ], ], ], 'ZeppelinMonitoringConfigurationDescription' => [ 'type' => 'structure', 'members' => [ 'LogLevel' => [ 'shape' => 'LogLevel', ], ], ], 'ZeppelinMonitoringConfigurationUpdate' => [ 'type' => 'structure', 'required' => [ 'LogLevelUpdate', ], 'members' => [ 'LogLevelUpdate' => [ 'shape' => 'LogLevel', ], ], ], 'ZipFileContent' => [ 'type' => 'blob', 'max' => 52428800, 'min' => 0, ], ],]; diff --git a/src/data/kinesisanalyticsv2/2018-05-23/docs-2.json b/src/data/kinesisanalyticsv2/2018-05-23/docs-2.json index fe619a7335..9169eed0b5 100644 --- a/src/data/kinesisanalyticsv2/2018-05-23/docs-2.json +++ b/src/data/kinesisanalyticsv2/2018-05-23/docs-2.json @@ -400,7 +400,7 @@ "CheckpointConfigurationDescription$CheckpointingEnabled": "Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
Describes updates to whether checkpointing is enabled for an application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
Displays verbose information about a Managed Service for Apache Flink application, including the application's job plan.
", - "FlinkRunConfiguration$AllowNonRestoredState": "When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
This value defaults to false
. If you update your application without specifying this parameter, AllowNonRestoredState
will be set to false
, even if it was previously set to true
.
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
This value defaults to false
. If you update your application without specifying this parameter, AllowNonRestoredState
will be set to false
, even if it was previously set to true
.
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
", "ParallelismConfigurationDescription$AutoScalingEnabled": "Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
", "ParallelismConfigurationUpdate$AutoScalingEnabledUpdate": "Describes updates to whether the Managed Service for Apache Flink service can increase the parallelism of a Managed Service for Apache Flink application in response to increased throughput.
", @@ -447,9 +447,9 @@ } }, "CheckpointConfiguration": { - "base": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
", + "base": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
", "refs": { - "FlinkApplicationConfiguration$CheckpointConfiguration": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
" + "FlinkApplicationConfiguration$CheckpointConfiguration": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
" } }, "CheckpointConfigurationDescription": { @@ -1088,7 +1088,7 @@ "JobPlanDescription": { "base": null, "refs": { - "FlinkApplicationConfigurationDescription$JobPlanDescription": "The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
" + "FlinkApplicationConfigurationDescription$JobPlanDescription": "The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
" } }, "KinesisAnalyticsARN": { @@ -1329,7 +1329,7 @@ "MinPauseBetweenCheckpoints": { "base": null, "refs": { - "CheckpointConfiguration$MinPauseBetweenCheckpoints": "Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval
, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval
, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.
", + "base": "Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.
", "refs": { "FlinkApplicationConfiguration$ParallelismConfiguration": "Describes parameters for how an application executes multiple tasks simultaneously.
" } diff --git a/src/data/kinesisanalyticsv2/2018-05-23/docs-2.json.php b/src/data/kinesisanalyticsv2/2018-05-23/docs-2.json.php index 47d91a444f..7e86f05ba5 100644 --- a/src/data/kinesisanalyticsv2/2018-05-23/docs-2.json.php +++ b/src/data/kinesisanalyticsv2/2018-05-23/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon Managed Service for Apache Flink was previously known as Amazon Kinesis Data Analytics for Apache Flink.
Amazon Managed Service for Apache Flink is a fully managed service that you can use to process and analyze streaming data using Java, Python, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.
', 'operations' => [ 'AddApplicationCloudWatchLoggingOption' => 'Adds an Amazon CloudWatch log stream to monitor application configuration errors.
', 'AddApplicationInput' => 'Adds a streaming source to your SQL-based Kinesis Data Analytics application.
You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.
Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
', 'AddApplicationInputProcessingConfiguration' => 'Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application\'s SQL code executes. Currently, the only input processor available is Amazon Lambda.
', 'AddApplicationOutput' => 'Adds an external destination to your SQL-based Kinesis Data Analytics application.
If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.
You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors.
Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
', 'AddApplicationReferenceDataSource' => 'Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.
', 'AddApplicationVpcConfiguration' => 'Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.
Note the following about VPC configurations for Managed Service for Apache Flink applications:
VPC configurations are not supported for SQL applications.
When a VPC is added to a Managed Service for Apache Flink application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.
Creates a Managed Service for Apache Flink application. For information about creating a Managed Service for Apache Flink application, see Creating an Application.
', 'CreateApplicationPresignedUrl' => 'Creates and returns a URL that you can use to connect to an application\'s extension.
The IAM role or user used to call this API defines the permissions to access the extension. After 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 that attempts to connect to the extension.
You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds
parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.
The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.
Creates a snapshot of the application\'s state data.
', 'DeleteApplication' => 'Deletes the specified application. Managed Service for Apache Flink halts application execution and deletes the application.
', 'DeleteApplicationCloudWatchLoggingOption' => 'Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application.
', 'DeleteApplicationInputProcessingConfiguration' => 'Deletes an InputProcessingConfiguration from an input.
', 'DeleteApplicationOutput' => 'Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application\'s configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
', 'DeleteApplicationReferenceDataSource' => 'Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application\'s configuration.
If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
', 'DeleteApplicationSnapshot' => 'Deletes a snapshot of application state.
', 'DeleteApplicationVpcConfiguration' => 'Removes a VPC configuration from a Managed Service for Apache Flink application.
', 'DescribeApplication' => 'Returns information about a specific Managed Service for Apache Flink application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
', 'DescribeApplicationOperation' => 'Returns information about a specific operation performed on a Managed Service for Apache Flink application', 'DescribeApplicationSnapshot' => 'Returns information about a snapshot of application state data.
', 'DescribeApplicationVersion' => 'Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.
This operation is supported only for Managed Service for Apache Flink.
Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.
You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
', 'ListApplicationOperations' => 'Lists information about operations performed on a Managed Service for Apache Flink application', 'ListApplicationSnapshots' => 'Lists information about the current application snapshots.
', 'ListApplicationVersions' => 'Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.
To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.
This operation is supported only for Managed Service for Apache Flink.
Returns a list of Managed Service for Apache Flink applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.
If you want detailed information about a specific application, use DescribeApplication.
', 'ListTagsForResource' => 'Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
', 'RollbackApplication' => 'Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status or in the running status.
You can roll back an application only if it is in the UPDATING
, AUTOSCALING
, or RUNNING
statuses.
When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.
', 'StartApplication' => 'Starts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.
', 'StopApplication' => 'Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force
parameter to true
.
You can use the DescribeApplication operation to find the application status.
Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force
is set to true
.
Adds one or more key-value tags to a Managed Service for Apache Flink application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
', 'UntagResource' => 'Removes one or more tags from a Managed Service for Apache Flink application. For more information, see Using Tagging.
', 'UpdateApplication' => 'Updates an existing Managed Service for Apache Flink application. Using this operation, you can update application code, input configuration, and output configuration.
Managed Service for Apache Flink updates the ApplicationVersionId
each time you update your application.
Updates the maintenance configuration of the Managed Service for Apache Flink application.
You can invoke this operation on an application that is in one of the two following states: READY
or RUNNING
. If you invoke it when the application is in a state other than these two states, it throws a ResourceInUseException
. The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead.
To see the current maintenance configuration of your application, invoke the DescribeApplication operation.
For information about application maintenance, see Managed Service for Apache Flink for Apache Flink Maintenance.
This operation is supported only for Managed Service for Apache Flink.
Describes code configuration for an application.
', 'refs' => [ 'ApplicationConfiguration$ApplicationCodeConfiguration' => 'The code location and type parameters for a Managed Service for Apache Flink application.
', ], ], 'ApplicationCodeConfigurationDescription' => [ 'base' => 'Describes code configuration for an application.
', 'refs' => [ 'ApplicationConfigurationDescription$ApplicationCodeConfigurationDescription' => 'The details about the application code for a Managed Service for Apache Flink application.
', ], ], 'ApplicationCodeConfigurationUpdate' => [ 'base' => 'Describes code configuration updates for an application. This is supported for a Managed Service for Apache Flink application or a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'ApplicationConfigurationUpdate$ApplicationCodeConfigurationUpdate' => 'Describes updates to an application\'s code configuration.
', ], ], 'ApplicationConfiguration' => [ 'base' => 'Specifies the creation parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'CreateApplicationRequest$ApplicationConfiguration' => 'Use this parameter to configure the application.
', ], ], 'ApplicationConfigurationDescription' => [ 'base' => 'Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationDetail$ApplicationConfigurationDescription' => 'Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
', ], ], 'ApplicationConfigurationUpdate' => [ 'base' => 'Describes updates to an application\'s configuration.
', 'refs' => [ 'UpdateApplicationRequest$ApplicationConfigurationUpdate' => 'Describes application configuration updates.
', ], ], 'ApplicationDescription' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$ApplicationDescription' => 'The description of the application.
', 'CreateApplicationRequest$ApplicationDescription' => 'A summary description of the application.
', ], ], 'ApplicationDetail' => [ 'base' => 'Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
', 'refs' => [ 'CreateApplicationResponse$ApplicationDetail' => 'In response to your CreateApplication
request, Managed Service for Apache Flink returns a response with details of the application it created.
Provides a description of the application, such as the application\'s Amazon Resource Name (ARN), status, and latest version.
', 'DescribeApplicationVersionResponse$ApplicationVersionDetail' => NULL, 'RollbackApplicationResponse$ApplicationDetail' => NULL, 'UpdateApplicationResponse$ApplicationDetail' => 'Describes application updates.
', ], ], 'ApplicationMaintenanceConfigurationDescription' => [ 'base' => 'The details of the maintenance configuration for the application.
', 'refs' => [ 'ApplicationDetail$ApplicationMaintenanceConfigurationDescription' => 'The details of the maintenance configuration for the application.
', 'UpdateApplicationMaintenanceConfigurationResponse$ApplicationMaintenanceConfigurationDescription' => 'The application maintenance configuration description after the update.
', ], ], 'ApplicationMaintenanceConfigurationUpdate' => [ 'base' => 'Describes the updated maintenance configuration for the application.
', 'refs' => [ 'UpdateApplicationMaintenanceConfigurationRequest$ApplicationMaintenanceConfigurationUpdate' => 'Describes the application maintenance configuration update.
', ], ], 'ApplicationMaintenanceWindowEndTime' => [ 'base' => NULL, 'refs' => [ 'ApplicationMaintenanceConfigurationDescription$ApplicationMaintenanceWindowEndTime' => 'The end time for the maintenance window.
', ], ], 'ApplicationMaintenanceWindowStartTime' => [ 'base' => NULL, 'refs' => [ 'ApplicationMaintenanceConfigurationDescription$ApplicationMaintenanceWindowStartTime' => 'The start time for the maintenance window.
', 'ApplicationMaintenanceConfigurationUpdate$ApplicationMaintenanceWindowStartTimeUpdate' => 'The updated start time for the maintenance window.
', ], ], 'ApplicationMode' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$ApplicationMode' => 'To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE
. However, for a Managed Service for Apache Flink application, the mode is optional.
For a Managed Service for Apache Flink application, the mode is STREAMING
. For a Managed Service for Apache Flink Studio notebook, it is INTERACTIVE
.
Use the STREAMING
mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE
mode.
The Kinesis Data Analytics application name.
', 'AddApplicationInputProcessingConfigurationRequest$ApplicationName' => 'The name of the application to which you want to add the input processing configuration.
', 'AddApplicationInputRequest$ApplicationName' => 'The name of your existing application to which you want to add the streaming source.
', 'AddApplicationOutputRequest$ApplicationName' => 'The name of the application to which you want to add the output configuration.
', 'AddApplicationReferenceDataSourceRequest$ApplicationName' => 'The name of an existing application.
', 'AddApplicationVpcConfigurationRequest$ApplicationName' => 'The name of an existing application.
', 'ApplicationDetail$ApplicationName' => 'The name of the application.
', 'ApplicationSummary$ApplicationName' => 'The name of the application.
', 'CreateApplicationPresignedUrlRequest$ApplicationName' => 'The name of the application.
', 'CreateApplicationRequest$ApplicationName' => 'The name of your application (for example, sample-app
).
The name of an existing application
', 'DeleteApplicationCloudWatchLoggingOptionRequest$ApplicationName' => 'The application name.
', 'DeleteApplicationInputProcessingConfigurationRequest$ApplicationName' => 'The name of the application.
', 'DeleteApplicationOutputRequest$ApplicationName' => 'The application name.
', 'DeleteApplicationReferenceDataSourceRequest$ApplicationName' => 'The name of an existing application.
', 'DeleteApplicationRequest$ApplicationName' => 'The name of the application to delete.
', 'DeleteApplicationSnapshotRequest$ApplicationName' => 'The name of an existing application.
', 'DeleteApplicationVpcConfigurationRequest$ApplicationName' => 'The name of an existing application.
', 'DescribeApplicationOperationRequest$ApplicationName' => NULL, 'DescribeApplicationRequest$ApplicationName' => 'The name of the application.
', 'DescribeApplicationSnapshotRequest$ApplicationName' => 'The name of an existing application.
', 'DescribeApplicationVersionRequest$ApplicationName' => 'The name of the application for which you want to get the version description.
', 'ListApplicationOperationsRequest$ApplicationName' => NULL, 'ListApplicationSnapshotsRequest$ApplicationName' => 'The name of an existing application.
', 'ListApplicationVersionsRequest$ApplicationName' => 'The name of the application for which you want to list all versions.
', 'ListApplicationsRequest$NextToken' => 'If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface\'s Pagination Options.
', 'ListApplicationsResponse$NextToken' => 'The pagination token for the next set of results, or null
if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface\'s Pagination Options.
The name of the application.
', 'StartApplicationRequest$ApplicationName' => 'The name of the application.
', 'StopApplicationRequest$ApplicationName' => 'The name of the running application to stop.
', 'UpdateApplicationMaintenanceConfigurationRequest$ApplicationName' => 'The name of the application for which you want to update the maintenance configuration.
', 'UpdateApplicationRequest$ApplicationName' => 'The name of the application to update.
', ], ], 'ApplicationOperationInfo' => [ 'base' => 'Provides a description of the operation, such as the type and status of operation', 'refs' => [ 'ApplicationOperationInfoList$member' => NULL, ], ], 'ApplicationOperationInfoDetails' => [ 'base' => 'Provides a description of the operation, such as the operation-type and status', 'refs' => [ 'DescribeApplicationOperationResponse$ApplicationOperationInfoDetails' => NULL, ], ], 'ApplicationOperationInfoList' => [ 'base' => 'List of ApplicationOperationInfo for an application', 'refs' => [ 'ListApplicationOperationsResponse$ApplicationOperationInfoList' => NULL, ], ], 'ApplicationRestoreConfiguration' => [ 'base' => 'Specifies the method and snapshot to use when restarting an application using previously saved application state.
', 'refs' => [ 'RunConfiguration$ApplicationRestoreConfiguration' => 'Describes the restore behavior of a restarting application.
', 'RunConfigurationDescription$ApplicationRestoreConfigurationDescription' => 'Describes the restore behavior of a restarting application.
', 'RunConfigurationUpdate$ApplicationRestoreConfiguration' => 'Describes updates to the restore behavior of a restarting application.
', ], ], 'ApplicationRestoreType' => [ 'base' => NULL, 'refs' => [ 'ApplicationRestoreConfiguration$ApplicationRestoreType' => 'Specifies how the application should be restored.
', ], ], 'ApplicationSnapshotConfiguration' => [ 'base' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfiguration$ApplicationSnapshotConfiguration' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', ], ], 'ApplicationSnapshotConfigurationDescription' => [ 'base' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationDescription$ApplicationSnapshotConfigurationDescription' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', ], ], 'ApplicationSnapshotConfigurationUpdate' => [ 'base' => 'Describes updates to whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationUpdate$ApplicationSnapshotConfigurationUpdate' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', ], ], 'ApplicationStatus' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$ApplicationStatus' => 'The status of the application.
', 'ApplicationSummary$ApplicationStatus' => 'The status of the application.
', 'ApplicationVersionSummary$ApplicationStatus' => 'The status of the application.
', ], ], 'ApplicationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsResponse$ApplicationSummaries' => 'A list of ApplicationSummary
objects.
Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
', 'refs' => [ 'ApplicationSummaries$member' => NULL, ], ], 'ApplicationSystemRollbackConfiguration' => [ 'base' => 'Describes system rollback configuration for a Managed Service for Apache Flink application', 'refs' => [ 'ApplicationConfiguration$ApplicationSystemRollbackConfiguration' => NULL, ], ], 'ApplicationSystemRollbackConfigurationDescription' => [ 'base' => 'Describes system rollback configuration for a Managed Service for Apache Flink application', 'refs' => [ 'ApplicationConfigurationDescription$ApplicationSystemRollbackConfigurationDescription' => NULL, ], ], 'ApplicationSystemRollbackConfigurationUpdate' => [ 'base' => 'Describes system rollback configuration for a Managed Service for Apache Flink application', 'refs' => [ 'ApplicationConfigurationUpdate$ApplicationSystemRollbackConfigurationUpdate' => NULL, ], ], 'ApplicationVersionChangeDetails' => [ 'base' => 'Contains information about the application version changes due to an operation', 'refs' => [ 'ApplicationOperationInfoDetails$ApplicationVersionChangeDetails' => NULL, ], ], 'ApplicationVersionId' => [ 'base' => NULL, 'refs' => [ 'AddApplicationCloudWatchLoggingOptionRequest$CurrentApplicationVersionId' => 'The version ID of the SQL-based Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId
or the ConditionalToken
.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
The new version ID of the SQL-based Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId
each time you change the CloudWatch logging options.
The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
Provides the current application version.
', 'AddApplicationInputRequest$CurrentApplicationVersionId' => 'The current version of your application. You must provide the ApplicationVersionID
or the ConditionalToken
.You can use the DescribeApplication operation to find the current application version.
Provides the current application version.
', 'AddApplicationOutputRequest$CurrentApplicationVersionId' => 'The version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
', 'AddApplicationReferenceDataSourceRequest$CurrentApplicationVersionId' => 'The version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
', 'AddApplicationVpcConfigurationRequest$CurrentApplicationVersionId' => 'The version of the application to which you want to add the VPC configuration. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
', 'ApplicationDetail$ApplicationVersionId' => 'Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId
each time you update the application.
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
', 'ApplicationDetail$ApplicationVersionRolledBackFrom' => 'If you reverted the application using RollbackApplication, the application version when RollbackApplication
was called.
The version to which you want to roll back the application.
', 'ApplicationSummary$ApplicationVersionId' => 'Provides the current application version.
', 'ApplicationVersionChangeDetails$ApplicationVersionUpdatedFrom' => 'The operation was performed on this version of the application', 'ApplicationVersionChangeDetails$ApplicationVersionUpdatedTo' => 'The operation execution resulted in the transition to the following version of the application', 'ApplicationVersionSummary$ApplicationVersionId' => 'The ID of the application version. Managed Service for Apache Flink updates the ApplicationVersionId
each time you update the application.
The version ID of the application. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId
each time you change the CloudWatch logging options.
The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The current application version ID.
', 'DeleteApplicationOutputRequest$CurrentApplicationVersionId' => 'The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The current application version ID.
', 'DeleteApplicationReferenceDataSourceRequest$CurrentApplicationVersionId' => 'The current application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The updated version ID of the application.
', 'DeleteApplicationVpcConfigurationRequest$CurrentApplicationVersionId' => 'The current application version ID. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
The updated version ID of the application.
', 'DescribeApplicationVersionRequest$ApplicationVersionId' => 'The ID of the application version for which you want to get the description.
', 'RollbackApplicationRequest$CurrentApplicationVersionId' => 'The current application version ID. You can retrieve the application version ID using DescribeApplication.
', 'SnapshotDetails$ApplicationVersionId' => 'The current application version ID when the snapshot was created.
', 'UpdateApplicationRequest$CurrentApplicationVersionId' => 'The current application version ID. You must provide the CurrentApplicationVersionId
or the ConditionalToken
.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A list of the application versions and the associated configuration summaries. The list includes application versions that were rolled back.
To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.
', ], ], 'ApplicationVersionSummary' => [ 'base' => 'The summary of the application version.
', 'refs' => [ 'ApplicationVersionSummaries$member' => NULL, ], ], 'ArtifactType' => [ 'base' => NULL, 'refs' => [ 'CustomArtifactConfiguration$ArtifactType' => ' UDF
stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR
can be in either Maven or an S3 bucket.
UDF
stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR
can be in either Maven or an S3 bucket.
The URL of the extension.
', ], ], 'BasePath' => [ 'base' => NULL, 'refs' => [ 'S3ContentBaseLocation$BasePath' => 'The base path for the S3 bucket.
', 'S3ContentBaseLocationDescription$BasePath' => 'The base path for the S3 bucket.
', 'S3ContentBaseLocationUpdate$BasePathUpdate' => 'The updated S3 bucket path.
', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'ApplicationSnapshotConfiguration$SnapshotsEnabled' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'ApplicationSnapshotConfigurationDescription$SnapshotsEnabled' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'ApplicationSnapshotConfigurationUpdate$SnapshotsEnabledUpdate' => 'Describes updates to whether snapshots are enabled for an application.
', 'ApplicationSystemRollbackConfiguration$RollbackEnabled' => 'Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application', 'ApplicationSystemRollbackConfigurationDescription$RollbackEnabled' => 'Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application', 'ApplicationSystemRollbackConfigurationUpdate$RollbackEnabledUpdate' => 'Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application', 'CheckpointConfiguration$CheckpointingEnabled' => 'Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
Describes updates to whether checkpointing is enabled for an application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
Displays verbose information about a Managed Service for Apache Flink application, including the application\'s job plan.
', 'FlinkRunConfiguration$AllowNonRestoredState' => 'When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
This value defaults to false
. If you update your application without specifying this parameter, AllowNonRestoredState
will be set to false
, even if it was previously set to true
.
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
', 'ParallelismConfigurationDescription$AutoScalingEnabled' => 'Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
', 'ParallelismConfigurationUpdate$AutoScalingEnabledUpdate' => 'Describes updates to whether the Managed Service for Apache Flink service can increase the parallelism of a Managed Service for Apache Flink application in response to increased throughput.
', 'StopApplicationRequest$Force' => 'Set to true
to force the application to stop. If you set Force
to true
, Managed Service for Apache Flink stops the application without taking a snapshot.
Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.
You can only force stop a Managed Service for Apache Flink application. You can\'t force stop a SQL-based Kinesis Data Analytics application.
The application must be in the STARTING
, UPDATING
, STOPPING
, AUTOSCALING
, or RUNNING
status.
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
', 'S3Configuration$BucketARN' => 'The ARN of the S3 bucket that contains the data.
', 'S3ContentBaseLocation$BucketARN' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ContentBaseLocationDescription$BucketARN' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ContentBaseLocationUpdate$BucketARNUpdate' => 'The updated Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ContentLocation$BucketARN' => 'The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
', 'S3ContentLocationUpdate$BucketARNUpdate' => 'The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.
', 'S3ReferenceDataSource$BucketARN' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ReferenceDataSourceDescription$BucketARN' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ReferenceDataSourceUpdate$BucketARNUpdate' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', ], ], 'CSVMappingParameters' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the \'\\n\' as the row delimiter and a comma (",") as the column delimiter:
"name1", "address1"
"name2", "address2"
Provides additional mapping information when the record format uses delimiters (for example, CSV).
', ], ], 'CatalogConfiguration' => [ 'base' => 'The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfiguration$CatalogConfiguration' => 'The Amazon Glue Data Catalog that you use in queries in a Managed Service for Apache Flink Studio notebook.
', ], ], 'CatalogConfigurationDescription' => [ 'base' => 'The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfigurationDescription$CatalogConfigurationDescription' => 'The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
', ], ], 'CatalogConfigurationUpdate' => [ 'base' => 'Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfigurationUpdate$CatalogConfigurationUpdate' => 'Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
', ], ], 'CheckpointConfiguration' => [ 'base' => 'Describes an application\'s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
', 'refs' => [ 'FlinkApplicationConfiguration$CheckpointConfiguration' => 'Describes an application\'s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
', ], ], 'CheckpointConfigurationDescription' => [ 'base' => 'Describes checkpointing parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'FlinkApplicationConfigurationDescription$CheckpointConfigurationDescription' => 'Describes an application\'s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
', ], ], 'CheckpointConfigurationUpdate' => [ 'base' => 'Describes updates to the checkpointing parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'FlinkApplicationConfigurationUpdate$CheckpointConfigurationUpdate' => 'Describes updates to an application\'s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
', ], ], 'CheckpointInterval' => [ 'base' => NULL, 'refs' => [ 'CheckpointConfiguration$CheckpointInterval' => 'Describes the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
Describes the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
Describes updates to the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).
', 'refs' => [ 'AddApplicationCloudWatchLoggingOptionRequest$CloudWatchLoggingOption' => 'Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
', 'CloudWatchLoggingOptions$member' => NULL, ], ], 'CloudWatchLoggingOptionDescription' => [ 'base' => 'Describes the Amazon CloudWatch logging option.
', 'refs' => [ 'CloudWatchLoggingOptionDescriptions$member' => NULL, ], ], 'CloudWatchLoggingOptionDescriptions' => [ 'base' => NULL, 'refs' => [ 'AddApplicationCloudWatchLoggingOptionResponse$CloudWatchLoggingOptionDescriptions' => 'The descriptions of the current CloudWatch logging options for the SQL-based Kinesis Data Analytics application.
', 'ApplicationDetail$CloudWatchLoggingOptionDescriptions' => 'Describes the application Amazon CloudWatch logging options.
', 'DeleteApplicationCloudWatchLoggingOptionResponse$CloudWatchLoggingOptionDescriptions' => 'The descriptions of the remaining CloudWatch logging options for the application.
', ], ], 'CloudWatchLoggingOptionUpdate' => [ 'base' => 'Describes the Amazon CloudWatch logging option updates.
', 'refs' => [ 'CloudWatchLoggingOptionUpdates$member' => NULL, ], ], 'CloudWatchLoggingOptionUpdates' => [ 'base' => NULL, 'refs' => [ 'UpdateApplicationRequest$CloudWatchLoggingOptionUpdates' => 'Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.
', ], ], 'CloudWatchLoggingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$CloudWatchLoggingOptions' => 'Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
', ], ], 'CodeContent' => [ 'base' => 'Specifies either the application code, or the location of the application code, for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationCodeConfiguration$CodeContent' => 'The location and type of the application code.
', ], ], 'CodeContentDescription' => [ 'base' => 'Describes details about the code of a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationCodeConfigurationDescription$CodeContentDescription' => 'Describes details about the location and format of the application code.
', ], ], 'CodeContentType' => [ 'base' => NULL, 'refs' => [ 'ApplicationCodeConfiguration$CodeContentType' => 'Specifies whether the code content is in text or zip format.
', 'ApplicationCodeConfigurationDescription$CodeContentType' => 'Specifies whether the code content is in text or zip format.
', 'ApplicationCodeConfigurationUpdate$CodeContentTypeUpdate' => 'Describes updates to the code content type.
', ], ], 'CodeContentUpdate' => [ 'base' => 'Describes an update to the code of an application. Not supported for Apache Zeppelin.
', 'refs' => [ 'ApplicationCodeConfigurationUpdate$CodeContentUpdate' => 'Describes updates to the code content of an application.
', ], ], 'CodeMD5' => [ 'base' => NULL, 'refs' => [ 'CodeContentDescription$CodeMD5' => 'The checksum that can be used to validate zip-format code.
', ], ], 'CodeSize' => [ 'base' => NULL, 'refs' => [ 'CodeContentDescription$CodeSize' => 'The size in bytes of the application code. Can be used to validate zip-format code.
', ], ], 'CodeValidationException' => [ 'base' => 'The user-provided application code (query) is not valid. This can be a simple syntax error.
', 'refs' => [], ], 'ConcurrentModificationException' => [ 'base' => 'Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
', 'refs' => [], ], 'ConditionalToken' => [ 'base' => NULL, 'refs' => [ 'AddApplicationCloudWatchLoggingOptionRequest$ConditionalToken' => 'A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A value you use to implement strong concurrency for application updates.
', 'DeleteApplicationCloudWatchLoggingOptionRequest$ConditionalToken' => 'A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
Describes whether the application uses Managed Service for Apache Flink\' default checkpointing behavior. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
Describes updates to whether the application uses the default checkpointing behavior of Managed Service for Apache Flink. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM
in order to set the LogLevel
or MetricsLevel
parameters.
Describes whether to use the default CloudWatch logging configuration for an application.
', 'MonitoringConfigurationUpdate$ConfigurationTypeUpdate' => 'Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM
in order to set the LogLevel
or MetricsLevel
parameters.
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service. You must set this property to CUSTOM
in order to change your application\'s AutoScalingEnabled
, Parallelism
, or ParallelismPerKPU
properties.
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.
', 'ParallelismConfigurationUpdate$ConfigurationTypeUpdate' => 'Describes updates to whether the application uses the default parallelism for the Managed Service for Apache Flink service, or if a custom parallelism is used. You must set this property to CUSTOM
in order to change your application\'s AutoScalingEnabled
, Parallelism
, or ParallelismPerKPU
properties.
Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
', 'refs' => [ 'CustomArtifactsConfigurationList$member' => NULL, ], ], 'CustomArtifactConfigurationDescription' => [ 'base' => 'Specifies a dependency JAR or a JAR of user-defined functions.
', 'refs' => [ 'CustomArtifactsConfigurationDescriptionList$member' => NULL, ], ], 'CustomArtifactsConfigurationDescriptionList' => [ 'base' => NULL, 'refs' => [ 'ZeppelinApplicationConfigurationDescription$CustomArtifactsConfigurationDescription' => 'Custom artifacts are dependency JARs and user-defined functions (UDF).
', ], ], 'CustomArtifactsConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ZeppelinApplicationConfiguration$CustomArtifactsConfiguration' => 'Custom artifacts are dependency JARs and user-defined functions (UDF).
', 'ZeppelinApplicationConfigurationUpdate$CustomArtifactsConfigurationUpdate' => 'Updates to the customer artifacts. Custom artifacts are dependency JAR files and user-defined functions (UDF).
', ], ], 'DatabaseARN' => [ 'base' => NULL, 'refs' => [ 'GlueDataCatalogConfiguration$DatabaseARN' => 'The Amazon Resource Name (ARN) of the database.
', 'GlueDataCatalogConfigurationDescription$DatabaseARN' => 'The Amazon Resource Name (ARN) of the database.
', 'GlueDataCatalogConfigurationUpdate$DatabaseARNUpdate' => 'The updated Amazon Resource Name (ARN) of the database.
', ], ], 'DeleteApplicationCloudWatchLoggingOptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationCloudWatchLoggingOptionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationInputProcessingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationInputProcessingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationOutputRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationOutputResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationReferenceDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationReferenceDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationSnapshotResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationVpcConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationVpcConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeployAsApplicationConfiguration' => [ 'base' => 'The information required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
', 'refs' => [ 'ZeppelinApplicationConfiguration$DeployAsApplicationConfiguration' => 'The information required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
', ], ], 'DeployAsApplicationConfigurationDescription' => [ 'base' => 'The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
', 'refs' => [ 'ZeppelinApplicationConfigurationDescription$DeployAsApplicationConfigurationDescription' => 'The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
', ], ], 'DeployAsApplicationConfigurationUpdate' => [ 'base' => 'Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
', 'refs' => [ 'ZeppelinApplicationConfigurationUpdate$DeployAsApplicationConfigurationUpdate' => NULL, ], ], 'DescribeApplicationOperationRequest' => [ 'base' => 'Request for information about a specific operation performed on a Managed Service for Apache Flink application', 'refs' => [], ], 'DescribeApplicationOperationResponse' => [ 'base' => 'Provides details of the operation corresponding to the operation-ID on a Managed Service for Apache Flink application', 'refs' => [], ], 'DescribeApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationSnapshotResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DestinationSchema' => [ 'base' => 'Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'Output$DestinationSchema' => 'Describes the data format when records are written to the destination.
', 'OutputDescription$DestinationSchema' => 'The data format used for writing data to the destination.
', 'OutputUpdate$DestinationSchemaUpdate' => 'Describes the data format when records are written to the destination.
', ], ], 'DiscoverInputSchemaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscoverInputSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'EnvironmentProperties' => [ 'base' => 'Describes execution properties for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfiguration$EnvironmentProperties' => 'Describes execution properties for a Managed Service for Apache Flink application.
', ], ], 'EnvironmentPropertyDescriptions' => [ 'base' => 'Describes the execution properties for an Apache Flink runtime.
', 'refs' => [ 'ApplicationConfigurationDescription$EnvironmentPropertyDescriptions' => 'Describes execution properties for a Managed Service for Apache Flink application.
', ], ], 'EnvironmentPropertyUpdates' => [ 'base' => 'Describes updates to the execution property groups for a Managed Service for Apache Flink application or a Studio notebook.
', 'refs' => [ 'ApplicationConfigurationUpdate$EnvironmentPropertyUpdates' => 'Describes updates to the environment properties for a Managed Service for Apache Flink application.
', ], ], 'ErrorInfo' => [ 'base' => 'Provides a description of the operation failure error', 'refs' => [ 'OperationFailureDetails$ErrorInfo' => NULL, ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'CodeValidationException$Message' => NULL, 'ConcurrentModificationException$Message' => NULL, 'InvalidApplicationConfigurationException$Message' => NULL, 'InvalidArgumentException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'ResourceInUseException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ResourceProvisionedThroughputExceededException$Message' => NULL, 'ServiceUnavailableException$Message' => NULL, 'TooManyTagsException$message' => NULL, 'UnableToDetectSchemaException$Message' => NULL, 'UnsupportedOperationException$Message' => NULL, ], ], 'ErrorString' => [ 'base' => 'Error message resulting in failure of the operation', 'refs' => [ 'ErrorInfo$ErrorString' => NULL, ], ], 'FileKey' => [ 'base' => NULL, 'refs' => [ 'S3ApplicationCodeLocationDescription$FileKey' => 'The file key for the object containing the application code.
', 'S3Configuration$FileKey' => 'The name of the object that contains the data.
', 'S3ContentLocation$FileKey' => 'The file key for the object containing the application code.
', 'S3ContentLocationUpdate$FileKeyUpdate' => 'The new file key for the object containing the application code.
', 'S3ReferenceDataSource$FileKey' => 'The object key name containing the reference data.
', 'S3ReferenceDataSourceDescription$FileKey' => 'Amazon S3 object key name.
', 'S3ReferenceDataSourceUpdate$FileKeyUpdate' => 'The object key name.
', ], ], 'FlinkApplicationConfiguration' => [ 'base' => 'Describes configuration parameters for a Managed Service for Apache Flink application or a Studio notebook.
', 'refs' => [ 'ApplicationConfiguration$FlinkApplicationConfiguration' => 'The creation and update parameters for a Managed Service for Apache Flink application.
', ], ], 'FlinkApplicationConfigurationDescription' => [ 'base' => 'Describes configuration parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationDescription$FlinkApplicationConfigurationDescription' => 'The details about a Managed Service for Apache Flink application.
', ], ], 'FlinkApplicationConfigurationUpdate' => [ 'base' => 'Describes updates to the configuration parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationUpdate$FlinkApplicationConfigurationUpdate' => 'Describes updates to a Managed Service for Apache Flink application\'s configuration.
', ], ], 'FlinkRunConfiguration' => [ 'base' => 'Describes the starting parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'RunConfiguration$FlinkRunConfiguration' => 'Describes the starting parameters for a Managed Service for Apache Flink application.
', 'RunConfigurationDescription$FlinkRunConfigurationDescription' => NULL, 'RunConfigurationUpdate$FlinkRunConfiguration' => 'Describes the starting parameters for a Managed Service for Apache Flink application.
', ], ], 'GlueDataCatalogConfiguration' => [ 'base' => 'The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.
', 'refs' => [ 'CatalogConfiguration$GlueDataCatalogConfiguration' => 'The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Managed Service for Apache Flink Studio notebook.
', ], ], 'GlueDataCatalogConfigurationDescription' => [ 'base' => 'The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.
', 'refs' => [ 'CatalogConfigurationDescription$GlueDataCatalogConfigurationDescription' => 'The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', ], ], 'GlueDataCatalogConfigurationUpdate' => [ 'base' => 'Updates to the configuration of the Glue Data Catalog that you use for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'CatalogConfigurationUpdate$GlueDataCatalogConfigurationUpdate' => 'Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', ], ], 'Id' => [ 'base' => NULL, 'refs' => [ 'AddApplicationInputProcessingConfigurationRequest$InputId' => 'The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.
', 'AddApplicationInputProcessingConfigurationResponse$InputId' => 'The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
', 'CloudWatchLoggingOptionDescription$CloudWatchLoggingOptionId' => 'The ID of the CloudWatch logging option description.
', 'CloudWatchLoggingOptionUpdate$CloudWatchLoggingOptionId' => 'The ID of the CloudWatch logging option to update
', 'DeleteApplicationCloudWatchLoggingOptionRequest$CloudWatchLoggingOptionId' => 'The CloudWatchLoggingOptionId
of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId
by using the DescribeApplication operation.
The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.
', 'DeleteApplicationOutputRequest$OutputId' => 'The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId
.
The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
', 'DeleteApplicationVpcConfigurationRequest$VpcConfigurationId' => 'The ID of the VPC configuration to delete.
', 'InputDescription$InputId' => 'The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
', 'InputUpdate$InputId' => 'The input ID of the application input to be updated.
', 'OutputDescription$OutputId' => 'A unique identifier for the output configuration.
', 'OutputUpdate$OutputId' => 'Identifies the specific output configuration that you want to update.
', 'PropertyGroup$PropertyGroupId' => 'Describes the key of an application execution property key-value pair.
', 'ReferenceDataSourceDescription$ReferenceId' => 'The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
', 'ReferenceDataSourceUpdate$ReferenceId' => 'The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.
', 'SqlRunConfiguration$InputId' => 'The input source ID. You can get this ID by calling the DescribeApplication operation.
', 'VpcConfigurationDescription$VpcConfigurationId' => 'The ID of the VPC configuration.
', 'VpcConfigurationUpdate$VpcConfigurationId' => 'Describes an update to the ID of the VPC configuration.
', ], ], 'InAppStreamName' => [ 'base' => NULL, 'refs' => [ 'InAppStreamNames$member' => NULL, 'Input$NamePrefix' => 'The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream
." Kinesis Data Analytics then creates one or more (as per the InputParallelism
count you specified) in-application streams with the names "MyInApplicationStream_001
," "MyInApplicationStream_002
," and so on.
The in-application name prefix.
', 'InputUpdate$NamePrefixUpdate' => 'The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.
', 'Output$Name' => 'The name of the in-application stream.
', 'OutputDescription$Name' => 'The name of the in-application stream that is configured as output.
', 'OutputUpdate$NameUpdate' => 'If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.
', ], ], 'InAppStreamNames' => [ 'base' => NULL, 'refs' => [ 'InputDescription$InAppStreamNames' => 'Returns the in-application stream names that are mapped to the stream source.
', ], ], 'InAppTableName' => [ 'base' => NULL, 'refs' => [ 'ReferenceDataSource$TableName' => 'The name of the in-application table to create.
', 'ReferenceDataSourceDescription$TableName' => 'The in-application table name created by the specific reference data source configuration.
', 'ReferenceDataSourceUpdate$TableNameUpdate' => 'The in-application table name that is created by this update.
', ], ], 'Input' => [ 'base' => 'When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.
', 'refs' => [ 'AddApplicationInputRequest$Input' => 'The Input to add.
', 'Inputs$member' => NULL, ], ], 'InputDescription' => [ 'base' => 'Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'InputDescriptions$member' => NULL, ], ], 'InputDescriptions' => [ 'base' => NULL, 'refs' => [ 'AddApplicationInputResponse$InputDescriptions' => 'Describes the application input configuration.
', 'SqlApplicationConfigurationDescription$InputDescriptions' => 'The array of InputDescription objects describing the input streams used by the application.
', ], ], 'InputLambdaProcessor' => [ 'base' => 'An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'InputProcessingConfiguration$InputLambdaProcessor' => 'The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
', ], ], 'InputLambdaProcessorDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream.
', 'refs' => [ 'InputProcessingConfigurationDescription$InputLambdaProcessorDescription' => 'Provides configuration information about the associated InputLambdaProcessorDescription
', ], ], 'InputLambdaProcessorUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.
', 'refs' => [ 'InputProcessingConfigurationUpdate$InputLambdaProcessorUpdate' => 'Provides update information for an InputLambdaProcessor.
', ], ], 'InputParallelism' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.
', 'refs' => [ 'Input$InputParallelism' => 'Describes the number of in-application streams to create.
', 'InputDescription$InputParallelism' => 'Describes the configured parallelism (number of in-application streams mapped to the streaming source).
', ], ], 'InputParallelismCount' => [ 'base' => NULL, 'refs' => [ 'InputParallelism$Count' => 'The number of in-application streams to create.
', 'InputParallelismUpdate$CountUpdate' => 'The number of in-application streams to create for the specified streaming source.
', ], ], 'InputParallelismUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.
', 'refs' => [ 'InputUpdate$InputParallelismUpdate' => 'Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).
', ], ], 'InputProcessingConfiguration' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is Amazon Lambda.
', 'refs' => [ 'AddApplicationInputProcessingConfigurationRequest$InputProcessingConfiguration' => 'The InputProcessingConfiguration to add to the application.
', 'DiscoverInputSchemaRequest$InputProcessingConfiguration' => 'The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
', 'Input$InputProcessingConfiguration' => 'The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application\'s SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.
', ], ], 'InputProcessingConfigurationDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides the configuration information about an input processor. Currently, the only input processor available is Amazon Lambda.
', 'refs' => [ 'AddApplicationInputProcessingConfigurationResponse$InputProcessingConfigurationDescription' => 'The description of the preprocessor that executes on records in this input before the application\'s code is run.
', 'InputDescription$InputProcessingConfigurationDescription' => 'The description of the preprocessor that executes on records in this input before the application\'s code is run.
', ], ], 'InputProcessingConfigurationUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration.
', 'refs' => [ 'InputUpdate$InputProcessingConfigurationUpdate' => 'Describes updates to an InputProcessingConfiguration.
', ], ], 'InputSchemaUpdate' => [ 'base' => 'Describes updates for an SQL-based Kinesis Data Analytics application\'s input schema.
', 'refs' => [ 'InputUpdate$InputSchemaUpdate' => 'Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.
', ], ], 'InputStartingPosition' => [ 'base' => NULL, 'refs' => [ 'InputStartingPositionConfiguration$InputStartingPosition' => 'The starting position on the stream.
NOW
- Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
TRIM_HORIZON
- Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
LAST_STOPPED_POINT
- Resume reading from where the application last stopped reading.
Describes the point at which the application reads from the streaming source.
', 'refs' => [ 'DiscoverInputSchemaRequest$InputStartingPositionConfiguration' => 'The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source for discovery purposes.
', 'InputDescription$InputStartingPositionConfiguration' => 'The point at which the application is configured to read from the input stream.
', 'SqlRunConfiguration$InputStartingPositionConfiguration' => 'The point at which you want the application to start processing records from the streaming source.
', ], ], 'InputUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId
of an application).
The array of InputUpdate objects describing the new input streams used by the application.
', ], ], 'Inputs' => [ 'base' => NULL, 'refs' => [ 'SqlApplicationConfiguration$Inputs' => 'The array of Input objects describing the input streams used by the application.
', ], ], 'InvalidApplicationConfigurationException' => [ 'base' => 'The user-provided application configuration is not valid.
', 'refs' => [], ], 'InvalidArgumentException' => [ 'base' => 'The specified input parameter value is not valid.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'The request JSON is not valid for the operation.
', 'refs' => [], ], 'JSONMappingParameters' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.
', 'refs' => [ 'MappingParameters$JSONMappingParameters' => 'Provides additional mapping information when JSON is the record format on the streaming source.
', ], ], 'JobPlanDescription' => [ 'base' => NULL, 'refs' => [ 'FlinkApplicationConfigurationDescription$JobPlanDescription' => 'The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
', ], ], 'KinesisAnalyticsARN' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => 'The ARN of the application for which to retrieve tags.
', 'TagResourceRequest$ResourceARN' => 'The ARN of the application to assign the tags.
', 'UntagResourceRequest$ResourceARN' => 'The ARN of the Managed Service for Apache Flink application from which to remove the tags.
', ], ], 'KinesisFirehoseInput' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream\'s Amazon Resource Name (ARN).
', 'refs' => [ 'Input$KinesisFirehoseInput' => 'If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream\'s ARN.
', ], ], 'KinesisFirehoseInputDescription' => [ 'base' => 'Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.
', 'refs' => [ 'InputDescription$KinesisFirehoseInputDescription' => 'If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream\'s ARN.
', ], ], 'KinesisFirehoseInputUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, when updating application input configuration, provides information about a Kinesis Data Firehose delivery stream as the streaming source.
', 'refs' => [ 'InputUpdate$KinesisFirehoseInputUpdate' => 'If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.
', ], ], 'KinesisFirehoseOutput' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) of the delivery stream.
', 'refs' => [ 'Output$KinesisFirehoseOutput' => 'Identifies a Kinesis Data Firehose delivery stream as the destination.
', ], ], 'KinesisFirehoseOutputDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application\'s output, describes the Kinesis Data Firehose delivery stream that is configured as its destination.
', 'refs' => [ 'OutputDescription$KinesisFirehoseOutputDescription' => 'Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
', ], ], 'KinesisFirehoseOutputUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, when updating an output configuration using the UpdateApplication operation, provides information about a Kinesis Data Firehose delivery stream that is configured as the destination.
', 'refs' => [ 'OutputUpdate$KinesisFirehoseOutputUpdate' => 'Describes a Kinesis Data Firehose delivery stream as the destination for the output.
', ], ], 'KinesisStreamsInput' => [ 'base' => 'Identifies a Kinesis data stream as the streaming source. You provide the stream\'s Amazon Resource Name (ARN).
', 'refs' => [ 'Input$KinesisStreamsInput' => 'If the streaming source is an Amazon Kinesis data stream, identifies the stream\'s Amazon Resource Name (ARN).
', ], ], 'KinesisStreamsInputDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the Kinesis data stream that is configured as the streaming source in the application input configuration.
', 'refs' => [ 'InputDescription$KinesisStreamsInputDescription' => 'If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream\'s Amazon Resource Name (ARN).
', ], ], 'KinesisStreamsInputUpdate' => [ 'base' => 'When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a Kinesis stream as the streaming source.
', 'refs' => [ 'InputUpdate$KinesisStreamsInputUpdate' => 'If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).
', ], ], 'KinesisStreamsOutput' => [ 'base' => 'When you configure a SQL-based Kinesis Data Analytics application\'s output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN).
', 'refs' => [ 'Output$KinesisStreamsOutput' => 'Identifies a Kinesis data stream as the destination.
', ], ], 'KinesisStreamsOutputDescription' => [ 'base' => 'For an SQL-based Kinesis Data Analytics application\'s output, describes the Kinesis data stream that is configured as its destination.
', 'refs' => [ 'OutputDescription$KinesisStreamsOutputDescription' => 'Describes the Kinesis data stream that is configured as the destination where output is written.
', ], ], 'KinesisStreamsOutputUpdate' => [ 'base' => 'When you update a SQL-based Kinesis Data Analytics application\'s output configuration using the UpdateApplication operation, provides information about a Kinesis data stream that is configured as the destination.
', 'refs' => [ 'OutputUpdate$KinesisStreamsOutputUpdate' => 'Describes a Kinesis data stream as the destination for the output.
', ], ], 'LambdaOutput' => [ 'base' => 'When you configure a SQL-based Kinesis Data Analytics application\'s output, identifies an Amazon Lambda function as the destination. You provide the function Amazon Resource Name (ARN) of the Lambda function.
', 'refs' => [ 'Output$LambdaOutput' => 'Identifies an Amazon Lambda function as the destination.
', ], ], 'LambdaOutputDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application\'s output, describes the Amazon Lambda function that is configured as its destination.
', 'refs' => [ 'OutputDescription$LambdaOutputDescription' => 'Describes the Lambda function that is configured as the destination where output is written.
', ], ], 'LambdaOutputUpdate' => [ 'base' => 'When you update an SQL-based Kinesis Data Analytics application\'s output configuration using the UpdateApplication operation, provides information about an Amazon Lambda function that is configured as the destination.
', 'refs' => [ 'OutputUpdate$LambdaOutputUpdate' => 'Describes an Amazon Lambda function as the destination for the output.
', ], ], 'LimitExceededException' => [ 'base' => 'The number of allowed resources has been exceeded.
', 'refs' => [], ], 'ListApplicationOperationsInputLimit' => [ 'base' => 'Limit on the number of records returned in the response', 'refs' => [ 'ListApplicationOperationsRequest$Limit' => NULL, ], ], 'ListApplicationOperationsRequest' => [ 'base' => 'Request to list operations performed on an application', 'refs' => [], ], 'ListApplicationOperationsResponse' => [ 'base' => 'Response with the list of operations for an application', 'refs' => [], ], 'ListApplicationSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationSnapshotsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationVersionsInputLimit' => [ 'base' => NULL, 'refs' => [ 'ListApplicationVersionsRequest$Limit' => 'The maximum number of versions to list in this invocation of the operation.
', ], ], 'ListApplicationVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationsInputLimit' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsRequest$Limit' => 'The maximum number of applications to list.
', ], ], 'ListApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSnapshotsInputLimit' => [ 'base' => NULL, 'refs' => [ 'ListApplicationSnapshotsRequest$Limit' => 'The maximum number of application snapshots to list.
', ], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogLevel' => [ 'base' => NULL, 'refs' => [ 'MonitoringConfiguration$LogLevel' => 'Describes the verbosity of the CloudWatch Logs for an application.
', 'MonitoringConfigurationDescription$LogLevel' => 'Describes the verbosity of the CloudWatch Logs for an application.
', 'MonitoringConfigurationUpdate$LogLevelUpdate' => 'Describes updates to the verbosity of the CloudWatch Logs for an application.
', 'ZeppelinMonitoringConfiguration$LogLevel' => 'The verbosity of the CloudWatch Logs for an application.
', 'ZeppelinMonitoringConfigurationDescription$LogLevel' => 'Describes the verbosity of the CloudWatch Logs for an application.
', 'ZeppelinMonitoringConfigurationUpdate$LogLevelUpdate' => 'Updates to the logging level for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
', ], ], 'LogStreamARN' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLoggingOption$LogStreamARN' => 'The ARN of the CloudWatch log to receive application messages.
', 'CloudWatchLoggingOptionDescription$LogStreamARN' => 'The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
', 'CloudWatchLoggingOptionUpdate$LogStreamARNUpdate' => 'The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
', ], ], 'MappingParameters' => [ 'base' => 'When you configure a SQL-based Kinesis Data Analytics application\'s input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
', 'refs' => [ 'RecordFormat$MappingParameters' => 'When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
', ], ], 'MavenArtifactId' => [ 'base' => NULL, 'refs' => [ 'MavenReference$ArtifactId' => 'The artifact ID of the Maven reference.
', ], ], 'MavenGroupId' => [ 'base' => NULL, 'refs' => [ 'MavenReference$GroupId' => 'The group ID of the Maven reference.
', ], ], 'MavenReference' => [ 'base' => 'The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.
', 'refs' => [ 'CustomArtifactConfiguration$MavenReference' => 'The parameters required to fully specify a Maven reference.
', 'CustomArtifactConfigurationDescription$MavenReferenceDescription' => 'The parameters that are required to specify a Maven dependency.
', ], ], 'MavenVersion' => [ 'base' => NULL, 'refs' => [ 'MavenReference$Version' => 'The version of the Maven reference.
', ], ], 'MetricsLevel' => [ 'base' => NULL, 'refs' => [ 'MonitoringConfiguration$MetricsLevel' => 'Describes the granularity of the CloudWatch Logs for an application. The Parallelism
level is not recommended for applications with a Parallelism over 64 due to excessive costs.
Describes the granularity of the CloudWatch Logs for an application.
', 'MonitoringConfigurationUpdate$MetricsLevelUpdate' => 'Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism
level is not recommended for applications with a Parallelism over 64 due to excessive costs.
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval
, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring.
', 'refs' => [ 'FlinkApplicationConfiguration$MonitoringConfiguration' => 'Describes configuration parameters for Amazon CloudWatch logging for an application.
', ], ], 'MonitoringConfigurationDescription' => [ 'base' => 'Describes configuration parameters for CloudWatch logging for an application.
', 'refs' => [ 'FlinkApplicationConfigurationDescription$MonitoringConfigurationDescription' => 'Describes configuration parameters for Amazon CloudWatch logging for an application.
', ], ], 'MonitoringConfigurationUpdate' => [ 'base' => 'Describes updates to configuration parameters for Amazon CloudWatch logging for an application.
', 'refs' => [ 'FlinkApplicationConfigurationUpdate$MonitoringConfigurationUpdate' => 'Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.
', ], ], 'NextToken' => [ 'base' => 'If a previous command returned a pagination token, pass it into this value to retrieve the next set of results', 'refs' => [ 'ListApplicationOperationsRequest$NextToken' => NULL, 'ListApplicationOperationsResponse$NextToken' => NULL, 'ListApplicationSnapshotsRequest$NextToken' => 'Use this parameter if you receive a NextToken
response in a previous request that indicates that there is more output available. Set it to the value of the previous call\'s NextToken
response to indicate where the output should continue from.
The token for the next set of results, or null
if there are no additional results.
If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface\'s Pagination Options.
', 'ListApplicationVersionsResponse$NextToken' => 'The pagination token for the next set of results, or null
if there are no additional results. To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see Using the Amazon Command Line Interface\'s Pagination Options.
The version of the object containing the application code.
', 'S3ContentLocation$ObjectVersion' => 'The version of the object containing the application code.
', 'S3ContentLocationUpdate$ObjectVersionUpdate' => 'The new version of the object containing the application code.
', ], ], 'Operation' => [ 'base' => 'Type of operation performed on an application', 'refs' => [ 'ApplicationOperationInfo$Operation' => NULL, 'ApplicationOperationInfoDetails$Operation' => NULL, 'ListApplicationOperationsRequest$Operation' => NULL, ], ], 'OperationFailureDetails' => [ 'base' => 'Provides a description of the operation failure', 'refs' => [ 'ApplicationOperationInfoDetails$OperationFailureDetails' => NULL, ], ], 'OperationId' => [ 'base' => 'Identifier of the Operation', 'refs' => [ 'AddApplicationCloudWatchLoggingOptionResponse$OperationId' => 'Operation ID for tracking AddApplicationCloudWatchLoggingOption request', 'AddApplicationVpcConfigurationResponse$OperationId' => 'Operation ID for tracking AddApplicationVpcConfiguration request', 'ApplicationOperationInfo$OperationId' => NULL, 'DeleteApplicationCloudWatchLoggingOptionResponse$OperationId' => 'Operation ID for tracking DeleteApplicationCloudWatchLoggingOption request', 'DeleteApplicationVpcConfigurationResponse$OperationId' => 'Operation ID for tracking DeleteApplicationVpcConfiguration request', 'DescribeApplicationOperationRequest$OperationId' => NULL, 'OperationFailureDetails$RollbackOperationId' => 'Provides the operation ID of a system-rollback operation executed due to failure in the current operation', 'RollbackApplicationResponse$OperationId' => 'Operation ID for tracking RollbackApplication request', 'StartApplicationResponse$OperationId' => 'Operation ID for tracking StartApplication request', 'StopApplicationResponse$OperationId' => 'Operation ID for tracking StopApplication request', 'UpdateApplicationResponse$OperationId' => 'Operation ID for tracking UpdateApplication request', ], ], 'OperationStatus' => [ 'base' => 'Status of the operation performed on an application', 'refs' => [ 'ApplicationOperationInfo$OperationStatus' => NULL, 'ApplicationOperationInfoDetails$OperationStatus' => NULL, 'ListApplicationOperationsRequest$OperationStatus' => NULL, ], ], 'Output' => [ 'base' => 'Describes a SQL-based Kinesis Data Analytics application\'s output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
', 'refs' => [ 'AddApplicationOutputRequest$Output' => 'An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.
', 'Outputs$member' => NULL, ], ], 'OutputDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
', 'refs' => [ 'OutputDescriptions$member' => NULL, ], ], 'OutputDescriptions' => [ 'base' => NULL, 'refs' => [ 'AddApplicationOutputResponse$OutputDescriptions' => 'Describes the application output configuration. For more information, see Configuring Application Output.
', 'SqlApplicationConfigurationDescription$OutputDescriptions' => 'The array of OutputDescription objects describing the destination streams used by the application.
', ], ], 'OutputUpdate' => [ 'base' => ' For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId
.
The array of OutputUpdate objects describing the new destination streams used by the application.
', ], ], 'Outputs' => [ 'base' => NULL, 'refs' => [ 'SqlApplicationConfiguration$Outputs' => 'The array of Output objects describing the destination streams used by the application.
', ], ], 'Parallelism' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$Parallelism' => 'Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, Managed Service for Apache Flink increases the CurrentParallelism
value in response to application load. The service can increase the CurrentParallelism
value up to the maximum parallelism, which is ParalellismPerKPU
times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism
value down to the Parallelism
setting.
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism
value in response to application load. The service can increase CurrentParallelism
up to the maximum parallelism, which is ParalellismPerKPU
times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism
value down to the Parallelism
setting.
Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, Managed Service for Apache Flink can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU
times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism
value down to the Parallelism
setting.
Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled
is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism
value in response to application load. The service can increase CurrentParallelism
up to the maximum parallelism, which is ParalellismPerKPU
times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism
down to the Parallelism
setting.
Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.
', 'refs' => [ 'FlinkApplicationConfiguration$ParallelismConfiguration' => 'Describes parameters for how an application executes multiple tasks simultaneously.
', ], ], 'ParallelismConfigurationDescription' => [ 'base' => 'Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously.
', 'refs' => [ 'FlinkApplicationConfigurationDescription$ParallelismConfigurationDescription' => 'Describes parameters for how an application executes multiple tasks simultaneously.
', ], ], 'ParallelismConfigurationUpdate' => [ 'base' => 'Describes updates to parameters for how an application executes multiple tasks simultaneously.
', 'refs' => [ 'FlinkApplicationConfigurationUpdate$ParallelismConfigurationUpdate' => 'Describes updates to the parameters for how an application executes multiple tasks simultaneously.
', ], ], 'ParallelismPerKPU' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$ParallelismPerKPU' => 'Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Managed Service for Apache Flink Pricing.
', 'ParallelismConfigurationDescription$ParallelismPerKPU' => 'Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.
', 'ParallelismConfigurationUpdate$ParallelismPerKPUUpdate' => 'Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.
', ], ], 'ParsedInputRecord' => [ 'base' => NULL, 'refs' => [ 'ParsedInputRecords$member' => NULL, ], ], 'ParsedInputRecordField' => [ 'base' => NULL, 'refs' => [ 'ParsedInputRecord$member' => NULL, ], ], 'ParsedInputRecords' => [ 'base' => NULL, 'refs' => [ 'DiscoverInputSchemaResponse$ParsedInputRecords' => 'An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).
', ], ], 'ProcessedInputRecord' => [ 'base' => NULL, 'refs' => [ 'ProcessedInputRecords$member' => NULL, ], ], 'ProcessedInputRecords' => [ 'base' => NULL, 'refs' => [ 'DiscoverInputSchemaResponse$ProcessedInputRecords' => 'The stream data that was modified by the processor specified in the InputProcessingConfiguration
parameter.
Stream data that was modified by the processor specified in the InputProcessingConfiguration
parameter.
Property key-value pairs passed into an application.
', 'refs' => [ 'PropertyGroups$member' => NULL, ], ], 'PropertyGroups' => [ 'base' => NULL, 'refs' => [ 'EnvironmentProperties$PropertyGroups' => 'Describes the execution property groups.
', 'EnvironmentPropertyDescriptions$PropertyGroupDescriptions' => 'Describes the execution property groups.
', 'EnvironmentPropertyUpdates$PropertyGroups' => 'Describes updates to the execution property groups.
', ], ], 'PropertyKey' => [ 'base' => NULL, 'refs' => [ 'PropertyMap$key' => NULL, ], ], 'PropertyMap' => [ 'base' => NULL, 'refs' => [ 'PropertyGroup$PropertyMap' => 'Describes the value of an application execution property key-value pair.
', ], ], 'PropertyValue' => [ 'base' => NULL, 'refs' => [ 'PropertyMap$value' => NULL, ], ], 'RawInputRecord' => [ 'base' => NULL, 'refs' => [ 'RawInputRecords$member' => NULL, ], ], 'RawInputRecords' => [ 'base' => NULL, 'refs' => [ 'DiscoverInputSchemaResponse$RawInputRecords' => 'The raw stream data that was sampled to infer the schema.
', 'UnableToDetectSchemaException$RawInputRecords' => 'Raw stream data that was sampled to infer the schema.
', ], ], 'RecordColumn' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
', 'refs' => [ 'RecordColumns$member' => NULL, ], ], 'RecordColumnDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVMappingParameters$RecordColumnDelimiter' => 'The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
', ], ], 'RecordColumnMapping' => [ 'base' => NULL, 'refs' => [ 'RecordColumn$Mapping' => 'A reference to the data element in the streaming input or the reference data source.
', ], ], 'RecordColumnName' => [ 'base' => NULL, 'refs' => [ 'RecordColumn$Name' => 'The name of the column that is created in the in-application input stream or reference table.
', ], ], 'RecordColumnSqlType' => [ 'base' => NULL, 'refs' => [ 'RecordColumn$SqlType' => 'The type of column created in the in-application input stream or reference table.
', ], ], 'RecordColumns' => [ 'base' => NULL, 'refs' => [ 'InputSchemaUpdate$RecordColumnUpdates' => 'A list of RecordColumn
objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
A list of RecordColumn
objects.
Specifies the encoding of the records in the streaming source; for example, UTF-8.
', 'SourceSchema$RecordEncoding' => 'Specifies the encoding of the records in the streaming source. For example, UTF-8.
', ], ], 'RecordFormat' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
', 'refs' => [ 'InputSchemaUpdate$RecordFormatUpdate' => 'Specifies the format of the records on the streaming source.
', 'SourceSchema$RecordFormat' => 'Specifies the format of the records on the streaming source.
', ], ], 'RecordFormatType' => [ 'base' => NULL, 'refs' => [ 'DestinationSchema$RecordFormatType' => 'Specifies the format of the records on the output stream.
', 'RecordFormat$RecordFormatType' => 'The type of record format.
', ], ], 'RecordRowDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVMappingParameters$RecordRowDelimiter' => 'The row delimiter. For example, in a CSV format, \'\\n\' is the typical row delimiter.
', ], ], 'RecordRowPath' => [ 'base' => NULL, 'refs' => [ 'JSONMappingParameters$RecordRowPath' => 'The path to the top-level parent that contains the records.
', ], ], 'ReferenceDataSource' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.
', 'refs' => [ 'AddApplicationReferenceDataSourceRequest$ReferenceDataSource' => 'The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.
', 'ReferenceDataSources$member' => NULL, ], ], 'ReferenceDataSourceDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
', 'refs' => [ 'ReferenceDataSourceDescriptions$member' => NULL, ], ], 'ReferenceDataSourceDescriptions' => [ 'base' => NULL, 'refs' => [ 'AddApplicationReferenceDataSourceResponse$ReferenceDataSourceDescriptions' => 'Describes reference data sources configured for the application.
', 'SqlApplicationConfigurationDescription$ReferenceDataSourceDescriptions' => 'The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
', ], ], 'ReferenceDataSourceUpdate' => [ 'base' => 'When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.
', 'refs' => [ 'ReferenceDataSourceUpdates$member' => NULL, ], ], 'ReferenceDataSourceUpdates' => [ 'base' => NULL, 'refs' => [ 'SqlApplicationConfigurationUpdate$ReferenceDataSourceUpdates' => 'The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.
', ], ], 'ReferenceDataSources' => [ 'base' => NULL, 'refs' => [ 'SqlApplicationConfiguration$ReferenceDataSources' => 'The array of ReferenceDataSource objects describing the reference data sources used by the application.
', ], ], 'ResourceARN' => [ 'base' => NULL, 'refs' => [ 'AddApplicationCloudWatchLoggingOptionResponse$ApplicationARN' => 'The application\'s ARN.
', 'AddApplicationInputProcessingConfigurationResponse$ApplicationARN' => 'The Amazon Resource Name (ARN) of the application.
', 'AddApplicationInputResponse$ApplicationARN' => 'The Amazon Resource Name (ARN) of the application.
', 'AddApplicationOutputResponse$ApplicationARN' => 'The application Amazon Resource Name (ARN).
', 'AddApplicationReferenceDataSourceResponse$ApplicationARN' => 'The application Amazon Resource Name (ARN).
', 'AddApplicationVpcConfigurationResponse$ApplicationARN' => 'The ARN of the application.
', 'ApplicationDetail$ApplicationARN' => 'The ARN of the application.
', 'ApplicationSummary$ApplicationARN' => 'The ARN of the application.
', 'DeleteApplicationCloudWatchLoggingOptionResponse$ApplicationARN' => 'The application\'s Amazon Resource Name (ARN).
', 'DeleteApplicationInputProcessingConfigurationResponse$ApplicationARN' => 'The Amazon Resource Name (ARN) of the application.
', 'DeleteApplicationOutputResponse$ApplicationARN' => 'The application Amazon Resource Name (ARN).
', 'DeleteApplicationReferenceDataSourceResponse$ApplicationARN' => 'The application Amazon Resource Name (ARN).
', 'DeleteApplicationVpcConfigurationResponse$ApplicationARN' => 'The ARN of the Managed Service for Apache Flink application.
', 'DiscoverInputSchemaRequest$ResourceARN' => 'The Amazon Resource Name (ARN) of the streaming source.
', 'InputLambdaProcessor$ResourceARN' => 'The ARN of the Amazon Lambda function that operates on records in the stream.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to preprocess the records in the stream.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The Amazon Resource Name (ARN) of the delivery stream.
', 'KinesisFirehoseInputDescription$ResourceARN' => 'The Amazon Resource Name (ARN) of the delivery stream.
', 'KinesisFirehoseInputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the input delivery stream to read.
', 'KinesisFirehoseOutput$ResourceARN' => 'The ARN of the destination delivery stream to write to.
', 'KinesisFirehoseOutputDescription$ResourceARN' => 'The Amazon Resource Name (ARN) of the delivery stream.
', 'KinesisFirehoseOutputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the delivery stream to write to.
', 'KinesisStreamsInput$ResourceARN' => 'The ARN of the input Kinesis data stream to read.
', 'KinesisStreamsInputDescription$ResourceARN' => 'The Amazon Resource Name (ARN) of the Kinesis data stream.
', 'KinesisStreamsInputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the input Kinesis data stream to read.
', 'KinesisStreamsOutput$ResourceARN' => 'The ARN of the destination Kinesis data stream to write to.
', 'KinesisStreamsOutputDescription$ResourceARN' => 'The Amazon Resource Name (ARN) of the Kinesis data stream.
', 'KinesisStreamsOutputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.
', 'LambdaOutput$ResourceARN' => 'The Amazon Resource Name (ARN) of the destination Lambda function to write to.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The Amazon Resource Name (ARN) of the destination Lambda function.
', 'LambdaOutputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the destination Amazon Lambda function.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The Amazon Resource Name (ARN) of the application.
', ], ], 'ResourceInUseException' => [ 'base' => 'The application is not available for this operation.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'Specified application can\'t be found.
', 'refs' => [], ], 'ResourceProvisionedThroughputExceededException' => [ 'base' => 'Discovery failed to get a record from the streaming source because of the Kinesis Streams ProvisionedThroughputExceededException
. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.
Specifies the IAM role that the application uses to access external resources.
', 'CloudWatchLoggingOptionDescription$RoleARN' => 'The IAM ARN of the role to use to send application messages.
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.
', 'DiscoverInputSchemaRequest$ServiceExecutionRole' => 'The ARN of the role that is used to access the streaming source.
', 'InputLambdaProcessorDescription$RoleARN' => 'The ARN of the IAM role that is used to access the Amazon Lambda function.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
Describes updates to the service execution role.
', ], ], 'RollbackApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'RollbackApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'RunConfiguration' => [ 'base' => 'Describes the starting parameters for an Managed Service for Apache Flink application.
', 'refs' => [ 'StartApplicationRequest$RunConfiguration' => 'Identifies the run configuration (start parameters) of a Managed Service for Apache Flink application.
', ], ], 'RunConfigurationDescription' => [ 'base' => 'Describes the starting properties for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationDescription$RunConfigurationDescription' => 'The details about the starting properties for a Managed Service for Apache Flink application.
', ], ], 'RunConfigurationUpdate' => [ 'base' => 'Describes the updates to the starting parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'UpdateApplicationRequest$RunConfigurationUpdate' => 'Describes updates to the application\'s starting parameters.
', ], ], 'RuntimeEnvironment' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$RuntimeEnvironment' => 'The runtime environment for the application.
', 'ApplicationSummary$RuntimeEnvironment' => 'The runtime environment for the application.
', 'CreateApplicationRequest$RuntimeEnvironment' => 'The runtime environment for the application.
', 'SnapshotDetails$RuntimeEnvironment' => 'The Flink Runtime for the application snapshot.
', 'UpdateApplicationRequest$RuntimeEnvironmentUpdate' => 'Updates the Managed Service for Apache Flink runtime environment used to run your code. To avoid issues you must:
Ensure your new jar and dependencies are compatible with the new runtime selected.
Ensure your new code\'s state is compatible with the snapshot from which your application will start
Describes the location of an application\'s code stored in an S3 bucket.
', 'refs' => [ 'CodeContentDescription$S3ApplicationCodeLocationDescription' => 'The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
', ], ], 'S3Configuration' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name of the Amazon S3 object that contains the data.
', 'refs' => [ 'DiscoverInputSchemaRequest$S3Configuration' => 'Specify this parameter to discover a schema from data in an Amazon S3 object.
', ], ], 'S3ContentBaseLocation' => [ 'base' => 'The S3 bucket that holds the application information.
', 'refs' => [ 'DeployAsApplicationConfiguration$S3ContentLocation' => 'The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
', ], ], 'S3ContentBaseLocationDescription' => [ 'base' => 'The description of the S3 base location that holds the application.
', 'refs' => [ 'DeployAsApplicationConfigurationDescription$S3ContentLocationDescription' => 'The location that holds the data required to specify an Amazon Data Analytics application.
', ], ], 'S3ContentBaseLocationUpdate' => [ 'base' => 'The information required to update the S3 base location that holds the application.
', 'refs' => [ 'DeployAsApplicationConfigurationUpdate$S3ContentLocationUpdate' => 'Updates to the location that holds the data required to specify an Amazon Data Analytics application.
', ], ], 'S3ContentLocation' => [ 'base' => 'For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
', 'refs' => [ 'CodeContent$S3ContentLocation' => 'Information about the Amazon S3 bucket that contains the application code.
', 'CustomArtifactConfiguration$S3ContentLocation' => NULL, 'CustomArtifactConfigurationDescription$S3ContentLocationDescription' => NULL, ], ], 'S3ContentLocationUpdate' => [ 'base' => 'Describes an update for the Amazon S3 code content location for an application.
', 'refs' => [ 'CodeContentUpdate$S3ContentLocationUpdate' => 'Describes an update to the location of code for an application.
', ], ], 'S3ReferenceDataSource' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data.
A SQL-based Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
', 'refs' => [ 'ReferenceDataSource$S3ReferenceDataSource' => 'Identifies the S3 bucket and object that contains the reference data. A SQL-based Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
', ], ], 'S3ReferenceDataSourceDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.
', 'refs' => [ 'ReferenceDataSourceDescription$S3ReferenceDataSourceDescription' => 'Provides the Amazon S3 bucket name, the object key name that contains the reference data.
', ], ], 'S3ReferenceDataSourceUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.
', 'refs' => [ 'ReferenceDataSourceUpdate$S3ReferenceDataSourceUpdate' => 'Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfiguration$SecurityGroupIds' => 'The array of SecurityGroup IDs used by the VPC configuration.
', 'VpcConfigurationDescription$SecurityGroupIds' => 'The array of SecurityGroup IDs used by the VPC configuration.
', 'VpcConfigurationUpdate$SecurityGroupIdUpdates' => 'Describes updates to the array of SecurityGroup IDs used by the VPC configuration.
', ], ], 'ServiceUnavailableException' => [ 'base' => 'The service cannot complete the request.
', 'refs' => [], ], 'SessionExpirationDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationPresignedUrlRequest$SessionExpirationDurationInSeconds' => 'The duration in seconds for which the returned URL will be valid.
', ], ], 'SnapshotDetails' => [ 'base' => 'Provides details about a snapshot of application state.
', 'refs' => [ 'DescribeApplicationSnapshotResponse$SnapshotDetails' => 'An object containing information about the application snapshot.
', 'SnapshotSummaries$member' => NULL, ], ], 'SnapshotName' => [ 'base' => NULL, 'refs' => [ 'ApplicationRestoreConfiguration$SnapshotName' => 'The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT
is specified for the ApplicationRestoreType
.
An identifier for the application snapshot.
', 'DeleteApplicationSnapshotRequest$SnapshotName' => 'The identifier for the snapshot delete.
', 'DescribeApplicationSnapshotRequest$SnapshotName' => 'The identifier of an application snapshot. You can retrieve this value using .
', 'SnapshotDetails$SnapshotName' => 'The identifier for the application snapshot.
', ], ], 'SnapshotStatus' => [ 'base' => NULL, 'refs' => [ 'SnapshotDetails$SnapshotStatus' => 'The status of the application snapshot.
', ], ], 'SnapshotSummaries' => [ 'base' => NULL, 'refs' => [ 'ListApplicationSnapshotsResponse$SnapshotSummaries' => 'A collection of objects containing information about the application snapshots.
', ], ], 'SourceSchema' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
', 'refs' => [ 'DiscoverInputSchemaResponse$InputSchema' => 'The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.
', 'Input$InputSchema' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
Also used to describe the format of the reference data source.
', 'InputDescription$InputSchema' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
', 'ReferenceDataSource$ReferenceSchema' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
', 'ReferenceDataSourceDescription$ReferenceSchema' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
', 'ReferenceDataSourceUpdate$ReferenceSchemaUpdate' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
', ], ], 'SqlApplicationConfiguration' => [ 'base' => 'Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'ApplicationConfiguration$SqlApplicationConfiguration' => 'The creation and update parameters for a SQL-based Kinesis Data Analytics application.
', ], ], 'SqlApplicationConfigurationDescription' => [ 'base' => 'Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'ApplicationConfigurationDescription$SqlApplicationConfigurationDescription' => 'The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
', ], ], 'SqlApplicationConfigurationUpdate' => [ 'base' => 'Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'ApplicationConfigurationUpdate$SqlApplicationConfigurationUpdate' => 'Describes updates to a SQL-based Kinesis Data Analytics application\'s configuration.
', ], ], 'SqlRunConfiguration' => [ 'base' => 'Describes the starting parameters for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'SqlRunConfigurations$member' => NULL, ], ], 'SqlRunConfigurations' => [ 'base' => NULL, 'refs' => [ 'RunConfiguration$SqlRunConfigurations' => 'Describes the starting parameters for a SQL-based Kinesis Data Analytics application application.
', ], ], 'StartApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfiguration$SubnetIds' => 'The array of Subnet IDs used by the VPC configuration.
', 'VpcConfigurationDescription$SubnetIds' => 'The array of Subnet IDs used by the VPC configuration.
', 'VpcConfigurationUpdate$SubnetIdUpdates' => 'Describes updates to the array of Subnet IDs used by the VPC configuration.
', ], ], 'Tag' => [ 'base' => 'A key-value pair (the value is optional) that you can define and assign to Amazon resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key of the key-value tag.
', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'A list of keys of tags to remove from the specified application.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value of the key-value tag. The value is optional.
', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$Tags' => 'A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
', 'ListTagsForResourceResponse$Tags' => 'The key-value tags assigned to the application.
', 'TagResourceRequest$Tags' => 'The key-value tags to assign to the application.
', ], ], 'TextContent' => [ 'base' => NULL, 'refs' => [ 'CodeContent$TextContent' => 'The text-format code for a Managed Service for Apache Flink application.
', 'CodeContentDescription$TextContent' => 'The text-format code
', 'CodeContentUpdate$TextContentUpdate' => 'Describes an update to the text code for an application.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$CreateTimestamp' => 'The current timestamp when the application was created.
', 'ApplicationDetail$LastUpdateTimestamp' => 'The current timestamp when the application was last updated.
', 'ApplicationDetail$ApplicationVersionCreateTimestamp' => 'The current timestamp when the application version was created.', 'ApplicationOperationInfo$StartTime' => 'The timestamp at which the operation was created', 'ApplicationOperationInfo$EndTime' => 'The timestamp at which the operation finished for the application', 'ApplicationOperationInfoDetails$StartTime' => 'The timestamp at which the operation was created', 'ApplicationOperationInfoDetails$EndTime' => 'The timestamp at which the operation finished for the application', 'DeleteApplicationRequest$CreateTimestamp' => 'Use the DescribeApplication
operation to get this value.
The creation timestamp of the application snapshot to delete. You can retrieve this value using or .
', 'SnapshotDetails$SnapshotCreationTimestamp' => 'The timestamp of the application snapshot.
', ], ], 'TooManyTagsException' => [ 'base' => 'Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
', 'refs' => [], ], 'UnableToDetectSchemaException' => [ 'base' => 'The data format is not valid. Kinesis Data Analytics cannot detect the schema for the given streaming source.
', 'refs' => [], ], 'UnsupportedOperationException' => [ 'base' => 'The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationMaintenanceConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationMaintenanceConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UrlType' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationPresignedUrlRequest$UrlType' => 'The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is FLINK_DASHBOARD_URL
.
Describes the parameters of a VPC used by the application.
', 'refs' => [ 'AddApplicationVpcConfigurationRequest$VpcConfiguration' => 'Description of the VPC to add to the application.
', 'VpcConfigurations$member' => NULL, ], ], 'VpcConfigurationDescription' => [ 'base' => 'Describes the parameters of a VPC used by the application.
', 'refs' => [ 'AddApplicationVpcConfigurationResponse$VpcConfigurationDescription' => 'The parameters of the new VPC configuration.
', 'VpcConfigurationDescriptions$member' => NULL, ], ], 'VpcConfigurationDescriptions' => [ 'base' => NULL, 'refs' => [ 'ApplicationConfigurationDescription$VpcConfigurationDescriptions' => 'The array of descriptions of VPC configurations available to the application.
', ], ], 'VpcConfigurationUpdate' => [ 'base' => 'Describes updates to the VPC configuration used by the application.
', 'refs' => [ 'VpcConfigurationUpdates$member' => NULL, ], ], 'VpcConfigurationUpdates' => [ 'base' => NULL, 'refs' => [ 'ApplicationConfigurationUpdate$VpcConfigurationUpdates' => 'Updates to the array of descriptions of VPC configurations available to the application.
', ], ], 'VpcConfigurations' => [ 'base' => NULL, 'refs' => [ 'ApplicationConfiguration$VpcConfigurations' => 'The array of descriptions of VPC configurations available to the application.
', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'VpcConfigurationDescription$VpcId' => 'The ID of the associated VPC.
', ], ], 'ZeppelinApplicationConfiguration' => [ 'base' => 'The configuration of a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ApplicationConfiguration$ZeppelinApplicationConfiguration' => 'The configuration parameters for a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinApplicationConfigurationDescription' => [ 'base' => 'The configuration of a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ApplicationConfigurationDescription$ZeppelinApplicationConfigurationDescription' => 'The configuration parameters for a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinApplicationConfigurationUpdate' => [ 'base' => 'Updates to the configuration of Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ApplicationConfigurationUpdate$ZeppelinApplicationConfigurationUpdate' => 'Updates to the configuration of a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinMonitoringConfiguration' => [ 'base' => 'Describes configuration parameters for Amazon CloudWatch logging for a Managed Service for Apache Flink Studio notebook. For more information about CloudWatch logging, see Monitoring.
', 'refs' => [ 'ZeppelinApplicationConfiguration$MonitoringConfiguration' => 'The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinMonitoringConfigurationDescription' => [ 'base' => 'The monitoring configuration for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfigurationDescription$MonitoringConfigurationDescription' => 'The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinMonitoringConfigurationUpdate' => [ 'base' => 'Updates to the monitoring configuration for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfigurationUpdate$MonitoringConfigurationUpdate' => 'Updates to the monitoring configuration of a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZipFileContent' => [ 'base' => NULL, 'refs' => [ 'CodeContent$ZipFileContent' => 'The zip-format code for a Managed Service for Apache Flink application.
', 'CodeContentUpdate$ZipFileContentUpdate' => 'Describes an update to the zipped code for an application.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Managed Service for Apache Flink was previously known as Amazon Kinesis Data Analytics for Apache Flink.
Amazon Managed Service for Apache Flink is a fully managed service that you can use to process and analyze streaming data using Java, Python, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.
', 'operations' => [ 'AddApplicationCloudWatchLoggingOption' => 'Adds an Amazon CloudWatch log stream to monitor application configuration errors.
', 'AddApplicationInput' => 'Adds a streaming source to your SQL-based Kinesis Data Analytics application.
You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.
Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
', 'AddApplicationInputProcessingConfiguration' => 'Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application\'s SQL code executes. Currently, the only input processor available is Amazon Lambda.
', 'AddApplicationOutput' => 'Adds an external destination to your SQL-based Kinesis Data Analytics application.
If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.
You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors.
Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
', 'AddApplicationReferenceDataSource' => 'Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.
', 'AddApplicationVpcConfiguration' => 'Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.
Note the following about VPC configurations for Managed Service for Apache Flink applications:
VPC configurations are not supported for SQL applications.
When a VPC is added to a Managed Service for Apache Flink application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.
Creates a Managed Service for Apache Flink application. For information about creating a Managed Service for Apache Flink application, see Creating an Application.
', 'CreateApplicationPresignedUrl' => 'Creates and returns a URL that you can use to connect to an application\'s extension.
The IAM role or user used to call this API defines the permissions to access the extension. After 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 that attempts to connect to the extension.
You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds
parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.
The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.
Creates a snapshot of the application\'s state data.
', 'DeleteApplication' => 'Deletes the specified application. Managed Service for Apache Flink halts application execution and deletes the application.
', 'DeleteApplicationCloudWatchLoggingOption' => 'Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application.
', 'DeleteApplicationInputProcessingConfiguration' => 'Deletes an InputProcessingConfiguration from an input.
', 'DeleteApplicationOutput' => 'Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application\'s configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
', 'DeleteApplicationReferenceDataSource' => 'Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application\'s configuration.
If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
', 'DeleteApplicationSnapshot' => 'Deletes a snapshot of application state.
', 'DeleteApplicationVpcConfiguration' => 'Removes a VPC configuration from a Managed Service for Apache Flink application.
', 'DescribeApplication' => 'Returns information about a specific Managed Service for Apache Flink application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
', 'DescribeApplicationOperation' => 'Returns information about a specific operation performed on a Managed Service for Apache Flink application', 'DescribeApplicationSnapshot' => 'Returns information about a snapshot of application state data.
', 'DescribeApplicationVersion' => 'Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.
This operation is supported only for Managed Service for Apache Flink.
Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.
You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
', 'ListApplicationOperations' => 'Lists information about operations performed on a Managed Service for Apache Flink application', 'ListApplicationSnapshots' => 'Lists information about the current application snapshots.
', 'ListApplicationVersions' => 'Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.
To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.
This operation is supported only for Managed Service for Apache Flink.
Returns a list of Managed Service for Apache Flink applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.
If you want detailed information about a specific application, use DescribeApplication.
', 'ListTagsForResource' => 'Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
', 'RollbackApplication' => 'Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status or in the running status.
You can roll back an application only if it is in the UPDATING
, AUTOSCALING
, or RUNNING
statuses.
When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.
', 'StartApplication' => 'Starts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.
', 'StopApplication' => 'Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force
parameter to true
.
You can use the DescribeApplication operation to find the application status.
Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force
is set to true
.
Adds one or more key-value tags to a Managed Service for Apache Flink application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
', 'UntagResource' => 'Removes one or more tags from a Managed Service for Apache Flink application. For more information, see Using Tagging.
', 'UpdateApplication' => 'Updates an existing Managed Service for Apache Flink application. Using this operation, you can update application code, input configuration, and output configuration.
Managed Service for Apache Flink updates the ApplicationVersionId
each time you update your application.
Updates the maintenance configuration of the Managed Service for Apache Flink application.
You can invoke this operation on an application that is in one of the two following states: READY
or RUNNING
. If you invoke it when the application is in a state other than these two states, it throws a ResourceInUseException
. The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead.
To see the current maintenance configuration of your application, invoke the DescribeApplication operation.
For information about application maintenance, see Managed Service for Apache Flink for Apache Flink Maintenance.
This operation is supported only for Managed Service for Apache Flink.
Describes code configuration for an application.
', 'refs' => [ 'ApplicationConfiguration$ApplicationCodeConfiguration' => 'The code location and type parameters for a Managed Service for Apache Flink application.
', ], ], 'ApplicationCodeConfigurationDescription' => [ 'base' => 'Describes code configuration for an application.
', 'refs' => [ 'ApplicationConfigurationDescription$ApplicationCodeConfigurationDescription' => 'The details about the application code for a Managed Service for Apache Flink application.
', ], ], 'ApplicationCodeConfigurationUpdate' => [ 'base' => 'Describes code configuration updates for an application. This is supported for a Managed Service for Apache Flink application or a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'ApplicationConfigurationUpdate$ApplicationCodeConfigurationUpdate' => 'Describes updates to an application\'s code configuration.
', ], ], 'ApplicationConfiguration' => [ 'base' => 'Specifies the creation parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'CreateApplicationRequest$ApplicationConfiguration' => 'Use this parameter to configure the application.
', ], ], 'ApplicationConfigurationDescription' => [ 'base' => 'Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationDetail$ApplicationConfigurationDescription' => 'Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
', ], ], 'ApplicationConfigurationUpdate' => [ 'base' => 'Describes updates to an application\'s configuration.
', 'refs' => [ 'UpdateApplicationRequest$ApplicationConfigurationUpdate' => 'Describes application configuration updates.
', ], ], 'ApplicationDescription' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$ApplicationDescription' => 'The description of the application.
', 'CreateApplicationRequest$ApplicationDescription' => 'A summary description of the application.
', ], ], 'ApplicationDetail' => [ 'base' => 'Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
', 'refs' => [ 'CreateApplicationResponse$ApplicationDetail' => 'In response to your CreateApplication
request, Managed Service for Apache Flink returns a response with details of the application it created.
Provides a description of the application, such as the application\'s Amazon Resource Name (ARN), status, and latest version.
', 'DescribeApplicationVersionResponse$ApplicationVersionDetail' => NULL, 'RollbackApplicationResponse$ApplicationDetail' => NULL, 'UpdateApplicationResponse$ApplicationDetail' => 'Describes application updates.
', ], ], 'ApplicationMaintenanceConfigurationDescription' => [ 'base' => 'The details of the maintenance configuration for the application.
', 'refs' => [ 'ApplicationDetail$ApplicationMaintenanceConfigurationDescription' => 'The details of the maintenance configuration for the application.
', 'UpdateApplicationMaintenanceConfigurationResponse$ApplicationMaintenanceConfigurationDescription' => 'The application maintenance configuration description after the update.
', ], ], 'ApplicationMaintenanceConfigurationUpdate' => [ 'base' => 'Describes the updated maintenance configuration for the application.
', 'refs' => [ 'UpdateApplicationMaintenanceConfigurationRequest$ApplicationMaintenanceConfigurationUpdate' => 'Describes the application maintenance configuration update.
', ], ], 'ApplicationMaintenanceWindowEndTime' => [ 'base' => NULL, 'refs' => [ 'ApplicationMaintenanceConfigurationDescription$ApplicationMaintenanceWindowEndTime' => 'The end time for the maintenance window.
', ], ], 'ApplicationMaintenanceWindowStartTime' => [ 'base' => NULL, 'refs' => [ 'ApplicationMaintenanceConfigurationDescription$ApplicationMaintenanceWindowStartTime' => 'The start time for the maintenance window.
', 'ApplicationMaintenanceConfigurationUpdate$ApplicationMaintenanceWindowStartTimeUpdate' => 'The updated start time for the maintenance window.
', ], ], 'ApplicationMode' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$ApplicationMode' => 'To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE
. However, for a Managed Service for Apache Flink application, the mode is optional.
For a Managed Service for Apache Flink application, the mode is STREAMING
. For a Managed Service for Apache Flink Studio notebook, it is INTERACTIVE
.
Use the STREAMING
mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE
mode.
The Kinesis Data Analytics application name.
', 'AddApplicationInputProcessingConfigurationRequest$ApplicationName' => 'The name of the application to which you want to add the input processing configuration.
', 'AddApplicationInputRequest$ApplicationName' => 'The name of your existing application to which you want to add the streaming source.
', 'AddApplicationOutputRequest$ApplicationName' => 'The name of the application to which you want to add the output configuration.
', 'AddApplicationReferenceDataSourceRequest$ApplicationName' => 'The name of an existing application.
', 'AddApplicationVpcConfigurationRequest$ApplicationName' => 'The name of an existing application.
', 'ApplicationDetail$ApplicationName' => 'The name of the application.
', 'ApplicationSummary$ApplicationName' => 'The name of the application.
', 'CreateApplicationPresignedUrlRequest$ApplicationName' => 'The name of the application.
', 'CreateApplicationRequest$ApplicationName' => 'The name of your application (for example, sample-app
).
The name of an existing application
', 'DeleteApplicationCloudWatchLoggingOptionRequest$ApplicationName' => 'The application name.
', 'DeleteApplicationInputProcessingConfigurationRequest$ApplicationName' => 'The name of the application.
', 'DeleteApplicationOutputRequest$ApplicationName' => 'The application name.
', 'DeleteApplicationReferenceDataSourceRequest$ApplicationName' => 'The name of an existing application.
', 'DeleteApplicationRequest$ApplicationName' => 'The name of the application to delete.
', 'DeleteApplicationSnapshotRequest$ApplicationName' => 'The name of an existing application.
', 'DeleteApplicationVpcConfigurationRequest$ApplicationName' => 'The name of an existing application.
', 'DescribeApplicationOperationRequest$ApplicationName' => NULL, 'DescribeApplicationRequest$ApplicationName' => 'The name of the application.
', 'DescribeApplicationSnapshotRequest$ApplicationName' => 'The name of an existing application.
', 'DescribeApplicationVersionRequest$ApplicationName' => 'The name of the application for which you want to get the version description.
', 'ListApplicationOperationsRequest$ApplicationName' => NULL, 'ListApplicationSnapshotsRequest$ApplicationName' => 'The name of an existing application.
', 'ListApplicationVersionsRequest$ApplicationName' => 'The name of the application for which you want to list all versions.
', 'ListApplicationsRequest$NextToken' => 'If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface\'s Pagination Options.
', 'ListApplicationsResponse$NextToken' => 'The pagination token for the next set of results, or null
if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface\'s Pagination Options.
The name of the application.
', 'StartApplicationRequest$ApplicationName' => 'The name of the application.
', 'StopApplicationRequest$ApplicationName' => 'The name of the running application to stop.
', 'UpdateApplicationMaintenanceConfigurationRequest$ApplicationName' => 'The name of the application for which you want to update the maintenance configuration.
', 'UpdateApplicationRequest$ApplicationName' => 'The name of the application to update.
', ], ], 'ApplicationOperationInfo' => [ 'base' => 'Provides a description of the operation, such as the type and status of operation', 'refs' => [ 'ApplicationOperationInfoList$member' => NULL, ], ], 'ApplicationOperationInfoDetails' => [ 'base' => 'Provides a description of the operation, such as the operation-type and status', 'refs' => [ 'DescribeApplicationOperationResponse$ApplicationOperationInfoDetails' => NULL, ], ], 'ApplicationOperationInfoList' => [ 'base' => 'List of ApplicationOperationInfo for an application', 'refs' => [ 'ListApplicationOperationsResponse$ApplicationOperationInfoList' => NULL, ], ], 'ApplicationRestoreConfiguration' => [ 'base' => 'Specifies the method and snapshot to use when restarting an application using previously saved application state.
', 'refs' => [ 'RunConfiguration$ApplicationRestoreConfiguration' => 'Describes the restore behavior of a restarting application.
', 'RunConfigurationDescription$ApplicationRestoreConfigurationDescription' => 'Describes the restore behavior of a restarting application.
', 'RunConfigurationUpdate$ApplicationRestoreConfiguration' => 'Describes updates to the restore behavior of a restarting application.
', ], ], 'ApplicationRestoreType' => [ 'base' => NULL, 'refs' => [ 'ApplicationRestoreConfiguration$ApplicationRestoreType' => 'Specifies how the application should be restored.
', ], ], 'ApplicationSnapshotConfiguration' => [ 'base' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfiguration$ApplicationSnapshotConfiguration' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', ], ], 'ApplicationSnapshotConfigurationDescription' => [ 'base' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationDescription$ApplicationSnapshotConfigurationDescription' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', ], ], 'ApplicationSnapshotConfigurationUpdate' => [ 'base' => 'Describes updates to whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationUpdate$ApplicationSnapshotConfigurationUpdate' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', ], ], 'ApplicationStatus' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$ApplicationStatus' => 'The status of the application.
', 'ApplicationSummary$ApplicationStatus' => 'The status of the application.
', 'ApplicationVersionSummary$ApplicationStatus' => 'The status of the application.
', ], ], 'ApplicationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsResponse$ApplicationSummaries' => 'A list of ApplicationSummary
objects.
Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
', 'refs' => [ 'ApplicationSummaries$member' => NULL, ], ], 'ApplicationSystemRollbackConfiguration' => [ 'base' => 'Describes system rollback configuration for a Managed Service for Apache Flink application', 'refs' => [ 'ApplicationConfiguration$ApplicationSystemRollbackConfiguration' => NULL, ], ], 'ApplicationSystemRollbackConfigurationDescription' => [ 'base' => 'Describes system rollback configuration for a Managed Service for Apache Flink application', 'refs' => [ 'ApplicationConfigurationDescription$ApplicationSystemRollbackConfigurationDescription' => NULL, ], ], 'ApplicationSystemRollbackConfigurationUpdate' => [ 'base' => 'Describes system rollback configuration for a Managed Service for Apache Flink application', 'refs' => [ 'ApplicationConfigurationUpdate$ApplicationSystemRollbackConfigurationUpdate' => NULL, ], ], 'ApplicationVersionChangeDetails' => [ 'base' => 'Contains information about the application version changes due to an operation', 'refs' => [ 'ApplicationOperationInfoDetails$ApplicationVersionChangeDetails' => NULL, ], ], 'ApplicationVersionId' => [ 'base' => NULL, 'refs' => [ 'AddApplicationCloudWatchLoggingOptionRequest$CurrentApplicationVersionId' => 'The version ID of the SQL-based Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId
or the ConditionalToken
.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
The new version ID of the SQL-based Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId
each time you change the CloudWatch logging options.
The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
Provides the current application version.
', 'AddApplicationInputRequest$CurrentApplicationVersionId' => 'The current version of your application. You must provide the ApplicationVersionID
or the ConditionalToken
.You can use the DescribeApplication operation to find the current application version.
Provides the current application version.
', 'AddApplicationOutputRequest$CurrentApplicationVersionId' => 'The version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
', 'AddApplicationReferenceDataSourceRequest$CurrentApplicationVersionId' => 'The version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
', 'AddApplicationVpcConfigurationRequest$CurrentApplicationVersionId' => 'The version of the application to which you want to add the VPC configuration. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
', 'ApplicationDetail$ApplicationVersionId' => 'Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId
each time you update the application.
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
', 'ApplicationDetail$ApplicationVersionRolledBackFrom' => 'If you reverted the application using RollbackApplication, the application version when RollbackApplication
was called.
The version to which you want to roll back the application.
', 'ApplicationSummary$ApplicationVersionId' => 'Provides the current application version.
', 'ApplicationVersionChangeDetails$ApplicationVersionUpdatedFrom' => 'The operation was performed on this version of the application', 'ApplicationVersionChangeDetails$ApplicationVersionUpdatedTo' => 'The operation execution resulted in the transition to the following version of the application', 'ApplicationVersionSummary$ApplicationVersionId' => 'The ID of the application version. Managed Service for Apache Flink updates the ApplicationVersionId
each time you update the application.
The version ID of the application. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId
each time you change the CloudWatch logging options.
The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The current application version ID.
', 'DeleteApplicationOutputRequest$CurrentApplicationVersionId' => 'The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The current application version ID.
', 'DeleteApplicationReferenceDataSourceRequest$CurrentApplicationVersionId' => 'The current application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
The updated version ID of the application.
', 'DeleteApplicationVpcConfigurationRequest$CurrentApplicationVersionId' => 'The current application version ID. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
The updated version ID of the application.
', 'DescribeApplicationVersionRequest$ApplicationVersionId' => 'The ID of the application version for which you want to get the description.
', 'RollbackApplicationRequest$CurrentApplicationVersionId' => 'The current application version ID. You can retrieve the application version ID using DescribeApplication.
', 'SnapshotDetails$ApplicationVersionId' => 'The current application version ID when the snapshot was created.
', 'UpdateApplicationRequest$CurrentApplicationVersionId' => 'The current application version ID. You must provide the CurrentApplicationVersionId
or the ConditionalToken
.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A list of the application versions and the associated configuration summaries. The list includes application versions that were rolled back.
To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.
', ], ], 'ApplicationVersionSummary' => [ 'base' => 'The summary of the application version.
', 'refs' => [ 'ApplicationVersionSummaries$member' => NULL, ], ], 'ArtifactType' => [ 'base' => NULL, 'refs' => [ 'CustomArtifactConfiguration$ArtifactType' => ' UDF
stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR
can be in either Maven or an S3 bucket.
UDF
stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR
can be in either Maven or an S3 bucket.
The URL of the extension.
', ], ], 'BasePath' => [ 'base' => NULL, 'refs' => [ 'S3ContentBaseLocation$BasePath' => 'The base path for the S3 bucket.
', 'S3ContentBaseLocationDescription$BasePath' => 'The base path for the S3 bucket.
', 'S3ContentBaseLocationUpdate$BasePathUpdate' => 'The updated S3 bucket path.
', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'ApplicationSnapshotConfiguration$SnapshotsEnabled' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'ApplicationSnapshotConfigurationDescription$SnapshotsEnabled' => 'Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
', 'ApplicationSnapshotConfigurationUpdate$SnapshotsEnabledUpdate' => 'Describes updates to whether snapshots are enabled for an application.
', 'ApplicationSystemRollbackConfiguration$RollbackEnabled' => 'Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application', 'ApplicationSystemRollbackConfigurationDescription$RollbackEnabled' => 'Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application', 'ApplicationSystemRollbackConfigurationUpdate$RollbackEnabledUpdate' => 'Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application', 'CheckpointConfiguration$CheckpointingEnabled' => 'Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
Describes updates to whether checkpointing is enabled for an application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
Displays verbose information about a Managed Service for Apache Flink application, including the application\'s job plan.
', 'FlinkRunConfiguration$AllowNonRestoredState' => 'When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
This value defaults to false
. If you update your application without specifying this parameter, AllowNonRestoredState
will be set to false
, even if it was previously set to true
.
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
', 'ParallelismConfigurationDescription$AutoScalingEnabled' => 'Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
', 'ParallelismConfigurationUpdate$AutoScalingEnabledUpdate' => 'Describes updates to whether the Managed Service for Apache Flink service can increase the parallelism of a Managed Service for Apache Flink application in response to increased throughput.
', 'StopApplicationRequest$Force' => 'Set to true
to force the application to stop. If you set Force
to true
, Managed Service for Apache Flink stops the application without taking a snapshot.
Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.
You can only force stop a Managed Service for Apache Flink application. You can\'t force stop a SQL-based Kinesis Data Analytics application.
The application must be in the STARTING
, UPDATING
, STOPPING
, AUTOSCALING
, or RUNNING
status.
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
', 'S3Configuration$BucketARN' => 'The ARN of the S3 bucket that contains the data.
', 'S3ContentBaseLocation$BucketARN' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ContentBaseLocationDescription$BucketARN' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ContentBaseLocationUpdate$BucketARNUpdate' => 'The updated Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ContentLocation$BucketARN' => 'The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
', 'S3ContentLocationUpdate$BucketARNUpdate' => 'The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.
', 'S3ReferenceDataSource$BucketARN' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ReferenceDataSourceDescription$BucketARN' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', 'S3ReferenceDataSourceUpdate$BucketARNUpdate' => 'The Amazon Resource Name (ARN) of the S3 bucket.
', ], ], 'CSVMappingParameters' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the \'\\n\' as the row delimiter and a comma (",") as the column delimiter:
"name1", "address1"
"name2", "address2"
Provides additional mapping information when the record format uses delimiters (for example, CSV).
', ], ], 'CatalogConfiguration' => [ 'base' => 'The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfiguration$CatalogConfiguration' => 'The Amazon Glue Data Catalog that you use in queries in a Managed Service for Apache Flink Studio notebook.
', ], ], 'CatalogConfigurationDescription' => [ 'base' => 'The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfigurationDescription$CatalogConfigurationDescription' => 'The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
', ], ], 'CatalogConfigurationUpdate' => [ 'base' => 'Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfigurationUpdate$CatalogConfigurationUpdate' => 'Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
', ], ], 'CheckpointConfiguration' => [ 'base' => 'Describes an application\'s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
', 'refs' => [ 'FlinkApplicationConfiguration$CheckpointConfiguration' => 'Describes an application\'s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
', ], ], 'CheckpointConfigurationDescription' => [ 'base' => 'Describes checkpointing parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'FlinkApplicationConfigurationDescription$CheckpointConfigurationDescription' => 'Describes an application\'s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
', ], ], 'CheckpointConfigurationUpdate' => [ 'base' => 'Describes updates to the checkpointing parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'FlinkApplicationConfigurationUpdate$CheckpointConfigurationUpdate' => 'Describes updates to an application\'s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
', ], ], 'CheckpointInterval' => [ 'base' => NULL, 'refs' => [ 'CheckpointConfiguration$CheckpointInterval' => 'Describes the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
Describes the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
Describes updates to the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).
', 'refs' => [ 'AddApplicationCloudWatchLoggingOptionRequest$CloudWatchLoggingOption' => 'Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
', 'CloudWatchLoggingOptions$member' => NULL, ], ], 'CloudWatchLoggingOptionDescription' => [ 'base' => 'Describes the Amazon CloudWatch logging option.
', 'refs' => [ 'CloudWatchLoggingOptionDescriptions$member' => NULL, ], ], 'CloudWatchLoggingOptionDescriptions' => [ 'base' => NULL, 'refs' => [ 'AddApplicationCloudWatchLoggingOptionResponse$CloudWatchLoggingOptionDescriptions' => 'The descriptions of the current CloudWatch logging options for the SQL-based Kinesis Data Analytics application.
', 'ApplicationDetail$CloudWatchLoggingOptionDescriptions' => 'Describes the application Amazon CloudWatch logging options.
', 'DeleteApplicationCloudWatchLoggingOptionResponse$CloudWatchLoggingOptionDescriptions' => 'The descriptions of the remaining CloudWatch logging options for the application.
', ], ], 'CloudWatchLoggingOptionUpdate' => [ 'base' => 'Describes the Amazon CloudWatch logging option updates.
', 'refs' => [ 'CloudWatchLoggingOptionUpdates$member' => NULL, ], ], 'CloudWatchLoggingOptionUpdates' => [ 'base' => NULL, 'refs' => [ 'UpdateApplicationRequest$CloudWatchLoggingOptionUpdates' => 'Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.
', ], ], 'CloudWatchLoggingOptions' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$CloudWatchLoggingOptions' => 'Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
', ], ], 'CodeContent' => [ 'base' => 'Specifies either the application code, or the location of the application code, for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationCodeConfiguration$CodeContent' => 'The location and type of the application code.
', ], ], 'CodeContentDescription' => [ 'base' => 'Describes details about the code of a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationCodeConfigurationDescription$CodeContentDescription' => 'Describes details about the location and format of the application code.
', ], ], 'CodeContentType' => [ 'base' => NULL, 'refs' => [ 'ApplicationCodeConfiguration$CodeContentType' => 'Specifies whether the code content is in text or zip format.
', 'ApplicationCodeConfigurationDescription$CodeContentType' => 'Specifies whether the code content is in text or zip format.
', 'ApplicationCodeConfigurationUpdate$CodeContentTypeUpdate' => 'Describes updates to the code content type.
', ], ], 'CodeContentUpdate' => [ 'base' => 'Describes an update to the code of an application. Not supported for Apache Zeppelin.
', 'refs' => [ 'ApplicationCodeConfigurationUpdate$CodeContentUpdate' => 'Describes updates to the code content of an application.
', ], ], 'CodeMD5' => [ 'base' => NULL, 'refs' => [ 'CodeContentDescription$CodeMD5' => 'The checksum that can be used to validate zip-format code.
', ], ], 'CodeSize' => [ 'base' => NULL, 'refs' => [ 'CodeContentDescription$CodeSize' => 'The size in bytes of the application code. Can be used to validate zip-format code.
', ], ], 'CodeValidationException' => [ 'base' => 'The user-provided application code (query) is not valid. This can be a simple syntax error.
', 'refs' => [], ], 'ConcurrentModificationException' => [ 'base' => 'Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
', 'refs' => [], ], 'ConditionalToken' => [ 'base' => NULL, 'refs' => [ 'AddApplicationCloudWatchLoggingOptionRequest$ConditionalToken' => 'A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A value you use to implement strong concurrency for application updates.
', 'DeleteApplicationCloudWatchLoggingOptionRequest$ConditionalToken' => 'A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application\'s current ConditionalToken
using DescribeApplication. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
Describes whether the application uses Managed Service for Apache Flink\' default checkpointing behavior. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
Describes updates to whether the application uses the default checkpointing behavior of Managed Service for Apache Flink. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM
in order to set the LogLevel
or MetricsLevel
parameters.
Describes whether to use the default CloudWatch logging configuration for an application.
', 'MonitoringConfigurationUpdate$ConfigurationTypeUpdate' => 'Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM
in order to set the LogLevel
or MetricsLevel
parameters.
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service. You must set this property to CUSTOM
in order to change your application\'s AutoScalingEnabled
, Parallelism
, or ParallelismPerKPU
properties.
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.
', 'ParallelismConfigurationUpdate$ConfigurationTypeUpdate' => 'Describes updates to whether the application uses the default parallelism for the Managed Service for Apache Flink service, or if a custom parallelism is used. You must set this property to CUSTOM
in order to change your application\'s AutoScalingEnabled
, Parallelism
, or ParallelismPerKPU
properties.
Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
', 'refs' => [ 'CustomArtifactsConfigurationList$member' => NULL, ], ], 'CustomArtifactConfigurationDescription' => [ 'base' => 'Specifies a dependency JAR or a JAR of user-defined functions.
', 'refs' => [ 'CustomArtifactsConfigurationDescriptionList$member' => NULL, ], ], 'CustomArtifactsConfigurationDescriptionList' => [ 'base' => NULL, 'refs' => [ 'ZeppelinApplicationConfigurationDescription$CustomArtifactsConfigurationDescription' => 'Custom artifacts are dependency JARs and user-defined functions (UDF).
', ], ], 'CustomArtifactsConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ZeppelinApplicationConfiguration$CustomArtifactsConfiguration' => 'Custom artifacts are dependency JARs and user-defined functions (UDF).
', 'ZeppelinApplicationConfigurationUpdate$CustomArtifactsConfigurationUpdate' => 'Updates to the customer artifacts. Custom artifacts are dependency JAR files and user-defined functions (UDF).
', ], ], 'DatabaseARN' => [ 'base' => NULL, 'refs' => [ 'GlueDataCatalogConfiguration$DatabaseARN' => 'The Amazon Resource Name (ARN) of the database.
', 'GlueDataCatalogConfigurationDescription$DatabaseARN' => 'The Amazon Resource Name (ARN) of the database.
', 'GlueDataCatalogConfigurationUpdate$DatabaseARNUpdate' => 'The updated Amazon Resource Name (ARN) of the database.
', ], ], 'DeleteApplicationCloudWatchLoggingOptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationCloudWatchLoggingOptionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationInputProcessingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationInputProcessingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationOutputRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationOutputResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationReferenceDataSourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationReferenceDataSourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationSnapshotResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationVpcConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteApplicationVpcConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeployAsApplicationConfiguration' => [ 'base' => 'The information required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
', 'refs' => [ 'ZeppelinApplicationConfiguration$DeployAsApplicationConfiguration' => 'The information required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
', ], ], 'DeployAsApplicationConfigurationDescription' => [ 'base' => 'The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
', 'refs' => [ 'ZeppelinApplicationConfigurationDescription$DeployAsApplicationConfigurationDescription' => 'The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
', ], ], 'DeployAsApplicationConfigurationUpdate' => [ 'base' => 'Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
', 'refs' => [ 'ZeppelinApplicationConfigurationUpdate$DeployAsApplicationConfigurationUpdate' => NULL, ], ], 'DescribeApplicationOperationRequest' => [ 'base' => 'Request for information about a specific operation performed on a Managed Service for Apache Flink application', 'refs' => [], ], 'DescribeApplicationOperationResponse' => [ 'base' => 'Provides details of the operation corresponding to the operation-ID on a Managed Service for Apache Flink application', 'refs' => [], ], 'DescribeApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationSnapshotResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeApplicationVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DestinationSchema' => [ 'base' => 'Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'Output$DestinationSchema' => 'Describes the data format when records are written to the destination.
', 'OutputDescription$DestinationSchema' => 'The data format used for writing data to the destination.
', 'OutputUpdate$DestinationSchemaUpdate' => 'Describes the data format when records are written to the destination.
', ], ], 'DiscoverInputSchemaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DiscoverInputSchemaResponse' => [ 'base' => NULL, 'refs' => [], ], 'EnvironmentProperties' => [ 'base' => 'Describes execution properties for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfiguration$EnvironmentProperties' => 'Describes execution properties for a Managed Service for Apache Flink application.
', ], ], 'EnvironmentPropertyDescriptions' => [ 'base' => 'Describes the execution properties for an Apache Flink runtime.
', 'refs' => [ 'ApplicationConfigurationDescription$EnvironmentPropertyDescriptions' => 'Describes execution properties for a Managed Service for Apache Flink application.
', ], ], 'EnvironmentPropertyUpdates' => [ 'base' => 'Describes updates to the execution property groups for a Managed Service for Apache Flink application or a Studio notebook.
', 'refs' => [ 'ApplicationConfigurationUpdate$EnvironmentPropertyUpdates' => 'Describes updates to the environment properties for a Managed Service for Apache Flink application.
', ], ], 'ErrorInfo' => [ 'base' => 'Provides a description of the operation failure error', 'refs' => [ 'OperationFailureDetails$ErrorInfo' => NULL, ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'CodeValidationException$Message' => NULL, 'ConcurrentModificationException$Message' => NULL, 'InvalidApplicationConfigurationException$Message' => NULL, 'InvalidArgumentException$Message' => NULL, 'InvalidRequestException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'ResourceInUseException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ResourceProvisionedThroughputExceededException$Message' => NULL, 'ServiceUnavailableException$Message' => NULL, 'TooManyTagsException$message' => NULL, 'UnableToDetectSchemaException$Message' => NULL, 'UnsupportedOperationException$Message' => NULL, ], ], 'ErrorString' => [ 'base' => 'Error message resulting in failure of the operation', 'refs' => [ 'ErrorInfo$ErrorString' => NULL, ], ], 'FileKey' => [ 'base' => NULL, 'refs' => [ 'S3ApplicationCodeLocationDescription$FileKey' => 'The file key for the object containing the application code.
', 'S3Configuration$FileKey' => 'The name of the object that contains the data.
', 'S3ContentLocation$FileKey' => 'The file key for the object containing the application code.
', 'S3ContentLocationUpdate$FileKeyUpdate' => 'The new file key for the object containing the application code.
', 'S3ReferenceDataSource$FileKey' => 'The object key name containing the reference data.
', 'S3ReferenceDataSourceDescription$FileKey' => 'Amazon S3 object key name.
', 'S3ReferenceDataSourceUpdate$FileKeyUpdate' => 'The object key name.
', ], ], 'FlinkApplicationConfiguration' => [ 'base' => 'Describes configuration parameters for a Managed Service for Apache Flink application or a Studio notebook.
', 'refs' => [ 'ApplicationConfiguration$FlinkApplicationConfiguration' => 'The creation and update parameters for a Managed Service for Apache Flink application.
', ], ], 'FlinkApplicationConfigurationDescription' => [ 'base' => 'Describes configuration parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationDescription$FlinkApplicationConfigurationDescription' => 'The details about a Managed Service for Apache Flink application.
', ], ], 'FlinkApplicationConfigurationUpdate' => [ 'base' => 'Describes updates to the configuration parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationUpdate$FlinkApplicationConfigurationUpdate' => 'Describes updates to a Managed Service for Apache Flink application\'s configuration.
', ], ], 'FlinkRunConfiguration' => [ 'base' => 'Describes the starting parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'RunConfiguration$FlinkRunConfiguration' => 'Describes the starting parameters for a Managed Service for Apache Flink application.
', 'RunConfigurationDescription$FlinkRunConfigurationDescription' => NULL, 'RunConfigurationUpdate$FlinkRunConfiguration' => 'Describes the starting parameters for a Managed Service for Apache Flink application.
', ], ], 'GlueDataCatalogConfiguration' => [ 'base' => 'The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.
', 'refs' => [ 'CatalogConfiguration$GlueDataCatalogConfiguration' => 'The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Managed Service for Apache Flink Studio notebook.
', ], ], 'GlueDataCatalogConfigurationDescription' => [ 'base' => 'The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.
', 'refs' => [ 'CatalogConfigurationDescription$GlueDataCatalogConfigurationDescription' => 'The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', ], ], 'GlueDataCatalogConfigurationUpdate' => [ 'base' => 'Updates to the configuration of the Glue Data Catalog that you use for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'CatalogConfigurationUpdate$GlueDataCatalogConfigurationUpdate' => 'Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
', ], ], 'Id' => [ 'base' => NULL, 'refs' => [ 'AddApplicationInputProcessingConfigurationRequest$InputId' => 'The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.
', 'AddApplicationInputProcessingConfigurationResponse$InputId' => 'The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
', 'CloudWatchLoggingOptionDescription$CloudWatchLoggingOptionId' => 'The ID of the CloudWatch logging option description.
', 'CloudWatchLoggingOptionUpdate$CloudWatchLoggingOptionId' => 'The ID of the CloudWatch logging option to update
', 'DeleteApplicationCloudWatchLoggingOptionRequest$CloudWatchLoggingOptionId' => 'The CloudWatchLoggingOptionId
of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId
by using the DescribeApplication operation.
The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.
', 'DeleteApplicationOutputRequest$OutputId' => 'The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId
.
The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
', 'DeleteApplicationVpcConfigurationRequest$VpcConfigurationId' => 'The ID of the VPC configuration to delete.
', 'InputDescription$InputId' => 'The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
', 'InputUpdate$InputId' => 'The input ID of the application input to be updated.
', 'OutputDescription$OutputId' => 'A unique identifier for the output configuration.
', 'OutputUpdate$OutputId' => 'Identifies the specific output configuration that you want to update.
', 'PropertyGroup$PropertyGroupId' => 'Describes the key of an application execution property key-value pair.
', 'ReferenceDataSourceDescription$ReferenceId' => 'The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
', 'ReferenceDataSourceUpdate$ReferenceId' => 'The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.
', 'SqlRunConfiguration$InputId' => 'The input source ID. You can get this ID by calling the DescribeApplication operation.
', 'VpcConfigurationDescription$VpcConfigurationId' => 'The ID of the VPC configuration.
', 'VpcConfigurationUpdate$VpcConfigurationId' => 'Describes an update to the ID of the VPC configuration.
', ], ], 'InAppStreamName' => [ 'base' => NULL, 'refs' => [ 'InAppStreamNames$member' => NULL, 'Input$NamePrefix' => 'The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream
." Kinesis Data Analytics then creates one or more (as per the InputParallelism
count you specified) in-application streams with the names "MyInApplicationStream_001
," "MyInApplicationStream_002
," and so on.
The in-application name prefix.
', 'InputUpdate$NamePrefixUpdate' => 'The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.
', 'Output$Name' => 'The name of the in-application stream.
', 'OutputDescription$Name' => 'The name of the in-application stream that is configured as output.
', 'OutputUpdate$NameUpdate' => 'If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.
', ], ], 'InAppStreamNames' => [ 'base' => NULL, 'refs' => [ 'InputDescription$InAppStreamNames' => 'Returns the in-application stream names that are mapped to the stream source.
', ], ], 'InAppTableName' => [ 'base' => NULL, 'refs' => [ 'ReferenceDataSource$TableName' => 'The name of the in-application table to create.
', 'ReferenceDataSourceDescription$TableName' => 'The in-application table name created by the specific reference data source configuration.
', 'ReferenceDataSourceUpdate$TableNameUpdate' => 'The in-application table name that is created by this update.
', ], ], 'Input' => [ 'base' => 'When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.
', 'refs' => [ 'AddApplicationInputRequest$Input' => 'The Input to add.
', 'Inputs$member' => NULL, ], ], 'InputDescription' => [ 'base' => 'Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'InputDescriptions$member' => NULL, ], ], 'InputDescriptions' => [ 'base' => NULL, 'refs' => [ 'AddApplicationInputResponse$InputDescriptions' => 'Describes the application input configuration.
', 'SqlApplicationConfigurationDescription$InputDescriptions' => 'The array of InputDescription objects describing the input streams used by the application.
', ], ], 'InputLambdaProcessor' => [ 'base' => 'An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'InputProcessingConfiguration$InputLambdaProcessor' => 'The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
', ], ], 'InputLambdaProcessorDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream.
', 'refs' => [ 'InputProcessingConfigurationDescription$InputLambdaProcessorDescription' => 'Provides configuration information about the associated InputLambdaProcessorDescription
', ], ], 'InputLambdaProcessorUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.
', 'refs' => [ 'InputProcessingConfigurationUpdate$InputLambdaProcessorUpdate' => 'Provides update information for an InputLambdaProcessor.
', ], ], 'InputParallelism' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.
', 'refs' => [ 'Input$InputParallelism' => 'Describes the number of in-application streams to create.
', 'InputDescription$InputParallelism' => 'Describes the configured parallelism (number of in-application streams mapped to the streaming source).
', ], ], 'InputParallelismCount' => [ 'base' => NULL, 'refs' => [ 'InputParallelism$Count' => 'The number of in-application streams to create.
', 'InputParallelismUpdate$CountUpdate' => 'The number of in-application streams to create for the specified streaming source.
', ], ], 'InputParallelismUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.
', 'refs' => [ 'InputUpdate$InputParallelismUpdate' => 'Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).
', ], ], 'InputProcessingConfiguration' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is Amazon Lambda.
', 'refs' => [ 'AddApplicationInputProcessingConfigurationRequest$InputProcessingConfiguration' => 'The InputProcessingConfiguration to add to the application.
', 'DiscoverInputSchemaRequest$InputProcessingConfiguration' => 'The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
', 'Input$InputProcessingConfiguration' => 'The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application\'s SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.
', ], ], 'InputProcessingConfigurationDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides the configuration information about an input processor. Currently, the only input processor available is Amazon Lambda.
', 'refs' => [ 'AddApplicationInputProcessingConfigurationResponse$InputProcessingConfigurationDescription' => 'The description of the preprocessor that executes on records in this input before the application\'s code is run.
', 'InputDescription$InputProcessingConfigurationDescription' => 'The description of the preprocessor that executes on records in this input before the application\'s code is run.
', ], ], 'InputProcessingConfigurationUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration.
', 'refs' => [ 'InputUpdate$InputProcessingConfigurationUpdate' => 'Describes updates to an InputProcessingConfiguration.
', ], ], 'InputSchemaUpdate' => [ 'base' => 'Describes updates for an SQL-based Kinesis Data Analytics application\'s input schema.
', 'refs' => [ 'InputUpdate$InputSchemaUpdate' => 'Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.
', ], ], 'InputStartingPosition' => [ 'base' => NULL, 'refs' => [ 'InputStartingPositionConfiguration$InputStartingPosition' => 'The starting position on the stream.
NOW
- Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
TRIM_HORIZON
- Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
LAST_STOPPED_POINT
- Resume reading from where the application last stopped reading.
Describes the point at which the application reads from the streaming source.
', 'refs' => [ 'DiscoverInputSchemaRequest$InputStartingPositionConfiguration' => 'The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source for discovery purposes.
', 'InputDescription$InputStartingPositionConfiguration' => 'The point at which the application is configured to read from the input stream.
', 'SqlRunConfiguration$InputStartingPositionConfiguration' => 'The point at which you want the application to start processing records from the streaming source.
', ], ], 'InputUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId
of an application).
The array of InputUpdate objects describing the new input streams used by the application.
', ], ], 'Inputs' => [ 'base' => NULL, 'refs' => [ 'SqlApplicationConfiguration$Inputs' => 'The array of Input objects describing the input streams used by the application.
', ], ], 'InvalidApplicationConfigurationException' => [ 'base' => 'The user-provided application configuration is not valid.
', 'refs' => [], ], 'InvalidArgumentException' => [ 'base' => 'The specified input parameter value is not valid.
', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => 'The request JSON is not valid for the operation.
', 'refs' => [], ], 'JSONMappingParameters' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.
', 'refs' => [ 'MappingParameters$JSONMappingParameters' => 'Provides additional mapping information when JSON is the record format on the streaming source.
', ], ], 'JobPlanDescription' => [ 'base' => NULL, 'refs' => [ 'FlinkApplicationConfigurationDescription$JobPlanDescription' => 'The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
', ], ], 'KinesisAnalyticsARN' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => 'The ARN of the application for which to retrieve tags.
', 'TagResourceRequest$ResourceARN' => 'The ARN of the application to assign the tags.
', 'UntagResourceRequest$ResourceARN' => 'The ARN of the Managed Service for Apache Flink application from which to remove the tags.
', ], ], 'KinesisFirehoseInput' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream\'s Amazon Resource Name (ARN).
', 'refs' => [ 'Input$KinesisFirehoseInput' => 'If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream\'s ARN.
', ], ], 'KinesisFirehoseInputDescription' => [ 'base' => 'Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.
', 'refs' => [ 'InputDescription$KinesisFirehoseInputDescription' => 'If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream\'s ARN.
', ], ], 'KinesisFirehoseInputUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, when updating application input configuration, provides information about a Kinesis Data Firehose delivery stream as the streaming source.
', 'refs' => [ 'InputUpdate$KinesisFirehoseInputUpdate' => 'If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.
', ], ], 'KinesisFirehoseOutput' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) of the delivery stream.
', 'refs' => [ 'Output$KinesisFirehoseOutput' => 'Identifies a Kinesis Data Firehose delivery stream as the destination.
', ], ], 'KinesisFirehoseOutputDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application\'s output, describes the Kinesis Data Firehose delivery stream that is configured as its destination.
', 'refs' => [ 'OutputDescription$KinesisFirehoseOutputDescription' => 'Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
', ], ], 'KinesisFirehoseOutputUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, when updating an output configuration using the UpdateApplication operation, provides information about a Kinesis Data Firehose delivery stream that is configured as the destination.
', 'refs' => [ 'OutputUpdate$KinesisFirehoseOutputUpdate' => 'Describes a Kinesis Data Firehose delivery stream as the destination for the output.
', ], ], 'KinesisStreamsInput' => [ 'base' => 'Identifies a Kinesis data stream as the streaming source. You provide the stream\'s Amazon Resource Name (ARN).
', 'refs' => [ 'Input$KinesisStreamsInput' => 'If the streaming source is an Amazon Kinesis data stream, identifies the stream\'s Amazon Resource Name (ARN).
', ], ], 'KinesisStreamsInputDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the Kinesis data stream that is configured as the streaming source in the application input configuration.
', 'refs' => [ 'InputDescription$KinesisStreamsInputDescription' => 'If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream\'s Amazon Resource Name (ARN).
', ], ], 'KinesisStreamsInputUpdate' => [ 'base' => 'When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a Kinesis stream as the streaming source.
', 'refs' => [ 'InputUpdate$KinesisStreamsInputUpdate' => 'If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).
', ], ], 'KinesisStreamsOutput' => [ 'base' => 'When you configure a SQL-based Kinesis Data Analytics application\'s output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN).
', 'refs' => [ 'Output$KinesisStreamsOutput' => 'Identifies a Kinesis data stream as the destination.
', ], ], 'KinesisStreamsOutputDescription' => [ 'base' => 'For an SQL-based Kinesis Data Analytics application\'s output, describes the Kinesis data stream that is configured as its destination.
', 'refs' => [ 'OutputDescription$KinesisStreamsOutputDescription' => 'Describes the Kinesis data stream that is configured as the destination where output is written.
', ], ], 'KinesisStreamsOutputUpdate' => [ 'base' => 'When you update a SQL-based Kinesis Data Analytics application\'s output configuration using the UpdateApplication operation, provides information about a Kinesis data stream that is configured as the destination.
', 'refs' => [ 'OutputUpdate$KinesisStreamsOutputUpdate' => 'Describes a Kinesis data stream as the destination for the output.
', ], ], 'LambdaOutput' => [ 'base' => 'When you configure a SQL-based Kinesis Data Analytics application\'s output, identifies an Amazon Lambda function as the destination. You provide the function Amazon Resource Name (ARN) of the Lambda function.
', 'refs' => [ 'Output$LambdaOutput' => 'Identifies an Amazon Lambda function as the destination.
', ], ], 'LambdaOutputDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application\'s output, describes the Amazon Lambda function that is configured as its destination.
', 'refs' => [ 'OutputDescription$LambdaOutputDescription' => 'Describes the Lambda function that is configured as the destination where output is written.
', ], ], 'LambdaOutputUpdate' => [ 'base' => 'When you update an SQL-based Kinesis Data Analytics application\'s output configuration using the UpdateApplication operation, provides information about an Amazon Lambda function that is configured as the destination.
', 'refs' => [ 'OutputUpdate$LambdaOutputUpdate' => 'Describes an Amazon Lambda function as the destination for the output.
', ], ], 'LimitExceededException' => [ 'base' => 'The number of allowed resources has been exceeded.
', 'refs' => [], ], 'ListApplicationOperationsInputLimit' => [ 'base' => 'Limit on the number of records returned in the response', 'refs' => [ 'ListApplicationOperationsRequest$Limit' => NULL, ], ], 'ListApplicationOperationsRequest' => [ 'base' => 'Request to list operations performed on an application', 'refs' => [], ], 'ListApplicationOperationsResponse' => [ 'base' => 'Response with the list of operations for an application', 'refs' => [], ], 'ListApplicationSnapshotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationSnapshotsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationVersionsInputLimit' => [ 'base' => NULL, 'refs' => [ 'ListApplicationVersionsRequest$Limit' => 'The maximum number of versions to list in this invocation of the operation.
', ], ], 'ListApplicationVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationsInputLimit' => [ 'base' => NULL, 'refs' => [ 'ListApplicationsRequest$Limit' => 'The maximum number of applications to list.
', ], ], 'ListApplicationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListApplicationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSnapshotsInputLimit' => [ 'base' => NULL, 'refs' => [ 'ListApplicationSnapshotsRequest$Limit' => 'The maximum number of application snapshots to list.
', ], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogLevel' => [ 'base' => NULL, 'refs' => [ 'MonitoringConfiguration$LogLevel' => 'Describes the verbosity of the CloudWatch Logs for an application.
', 'MonitoringConfigurationDescription$LogLevel' => 'Describes the verbosity of the CloudWatch Logs for an application.
', 'MonitoringConfigurationUpdate$LogLevelUpdate' => 'Describes updates to the verbosity of the CloudWatch Logs for an application.
', 'ZeppelinMonitoringConfiguration$LogLevel' => 'The verbosity of the CloudWatch Logs for an application.
', 'ZeppelinMonitoringConfigurationDescription$LogLevel' => 'Describes the verbosity of the CloudWatch Logs for an application.
', 'ZeppelinMonitoringConfigurationUpdate$LogLevelUpdate' => 'Updates to the logging level for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
', ], ], 'LogStreamARN' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLoggingOption$LogStreamARN' => 'The ARN of the CloudWatch log to receive application messages.
', 'CloudWatchLoggingOptionDescription$LogStreamARN' => 'The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
', 'CloudWatchLoggingOptionUpdate$LogStreamARNUpdate' => 'The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
', ], ], 'MappingParameters' => [ 'base' => 'When you configure a SQL-based Kinesis Data Analytics application\'s input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
', 'refs' => [ 'RecordFormat$MappingParameters' => 'When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
', ], ], 'MavenArtifactId' => [ 'base' => NULL, 'refs' => [ 'MavenReference$ArtifactId' => 'The artifact ID of the Maven reference.
', ], ], 'MavenGroupId' => [ 'base' => NULL, 'refs' => [ 'MavenReference$GroupId' => 'The group ID of the Maven reference.
', ], ], 'MavenReference' => [ 'base' => 'The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.
', 'refs' => [ 'CustomArtifactConfiguration$MavenReference' => 'The parameters required to fully specify a Maven reference.
', 'CustomArtifactConfigurationDescription$MavenReferenceDescription' => 'The parameters that are required to specify a Maven dependency.
', ], ], 'MavenVersion' => [ 'base' => NULL, 'refs' => [ 'MavenReference$Version' => 'The version of the Maven reference.
', ], ], 'MetricsLevel' => [ 'base' => NULL, 'refs' => [ 'MonitoringConfiguration$MetricsLevel' => 'Describes the granularity of the CloudWatch Logs for an application. The Parallelism
level is not recommended for applications with a Parallelism over 64 due to excessive costs.
Describes the granularity of the CloudWatch Logs for an application.
', 'MonitoringConfigurationUpdate$MetricsLevelUpdate' => 'Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism
level is not recommended for applications with a Parallelism over 64 due to excessive costs.
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval
, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring.
', 'refs' => [ 'FlinkApplicationConfiguration$MonitoringConfiguration' => 'Describes configuration parameters for Amazon CloudWatch logging for an application.
', ], ], 'MonitoringConfigurationDescription' => [ 'base' => 'Describes configuration parameters for CloudWatch logging for an application.
', 'refs' => [ 'FlinkApplicationConfigurationDescription$MonitoringConfigurationDescription' => 'Describes configuration parameters for Amazon CloudWatch logging for an application.
', ], ], 'MonitoringConfigurationUpdate' => [ 'base' => 'Describes updates to configuration parameters for Amazon CloudWatch logging for an application.
', 'refs' => [ 'FlinkApplicationConfigurationUpdate$MonitoringConfigurationUpdate' => 'Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.
', ], ], 'NextToken' => [ 'base' => 'If a previous command returned a pagination token, pass it into this value to retrieve the next set of results', 'refs' => [ 'ListApplicationOperationsRequest$NextToken' => NULL, 'ListApplicationOperationsResponse$NextToken' => NULL, 'ListApplicationSnapshotsRequest$NextToken' => 'Use this parameter if you receive a NextToken
response in a previous request that indicates that there is more output available. Set it to the value of the previous call\'s NextToken
response to indicate where the output should continue from.
The token for the next set of results, or null
if there are no additional results.
If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface\'s Pagination Options.
', 'ListApplicationVersionsResponse$NextToken' => 'The pagination token for the next set of results, or null
if there are no additional results. To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see Using the Amazon Command Line Interface\'s Pagination Options.
The version of the object containing the application code.
', 'S3ContentLocation$ObjectVersion' => 'The version of the object containing the application code.
', 'S3ContentLocationUpdate$ObjectVersionUpdate' => 'The new version of the object containing the application code.
', ], ], 'Operation' => [ 'base' => 'Type of operation performed on an application', 'refs' => [ 'ApplicationOperationInfo$Operation' => NULL, 'ApplicationOperationInfoDetails$Operation' => NULL, 'ListApplicationOperationsRequest$Operation' => NULL, ], ], 'OperationFailureDetails' => [ 'base' => 'Provides a description of the operation failure', 'refs' => [ 'ApplicationOperationInfoDetails$OperationFailureDetails' => NULL, ], ], 'OperationId' => [ 'base' => 'Identifier of the Operation', 'refs' => [ 'AddApplicationCloudWatchLoggingOptionResponse$OperationId' => 'Operation ID for tracking AddApplicationCloudWatchLoggingOption request', 'AddApplicationVpcConfigurationResponse$OperationId' => 'Operation ID for tracking AddApplicationVpcConfiguration request', 'ApplicationOperationInfo$OperationId' => NULL, 'DeleteApplicationCloudWatchLoggingOptionResponse$OperationId' => 'Operation ID for tracking DeleteApplicationCloudWatchLoggingOption request', 'DeleteApplicationVpcConfigurationResponse$OperationId' => 'Operation ID for tracking DeleteApplicationVpcConfiguration request', 'DescribeApplicationOperationRequest$OperationId' => NULL, 'OperationFailureDetails$RollbackOperationId' => 'Provides the operation ID of a system-rollback operation executed due to failure in the current operation', 'RollbackApplicationResponse$OperationId' => 'Operation ID for tracking RollbackApplication request', 'StartApplicationResponse$OperationId' => 'Operation ID for tracking StartApplication request', 'StopApplicationResponse$OperationId' => 'Operation ID for tracking StopApplication request', 'UpdateApplicationResponse$OperationId' => 'Operation ID for tracking UpdateApplication request', ], ], 'OperationStatus' => [ 'base' => 'Status of the operation performed on an application', 'refs' => [ 'ApplicationOperationInfo$OperationStatus' => NULL, 'ApplicationOperationInfoDetails$OperationStatus' => NULL, 'ListApplicationOperationsRequest$OperationStatus' => NULL, ], ], 'Output' => [ 'base' => 'Describes a SQL-based Kinesis Data Analytics application\'s output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
', 'refs' => [ 'AddApplicationOutputRequest$Output' => 'An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.
', 'Outputs$member' => NULL, ], ], 'OutputDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
', 'refs' => [ 'OutputDescriptions$member' => NULL, ], ], 'OutputDescriptions' => [ 'base' => NULL, 'refs' => [ 'AddApplicationOutputResponse$OutputDescriptions' => 'Describes the application output configuration. For more information, see Configuring Application Output.
', 'SqlApplicationConfigurationDescription$OutputDescriptions' => 'The array of OutputDescription objects describing the destination streams used by the application.
', ], ], 'OutputUpdate' => [ 'base' => ' For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId
.
The array of OutputUpdate objects describing the new destination streams used by the application.
', ], ], 'Outputs' => [ 'base' => NULL, 'refs' => [ 'SqlApplicationConfiguration$Outputs' => 'The array of Output objects describing the destination streams used by the application.
', ], ], 'Parallelism' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$Parallelism' => 'Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, Managed Service for Apache Flink increases the CurrentParallelism
value in response to application load. The service can increase the CurrentParallelism
value up to the maximum parallelism, which is ParalellismPerKPU
times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism
value down to the Parallelism
setting.
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism
value in response to application load. The service can increase CurrentParallelism
up to the maximum parallelism, which is ParalellismPerKPU
times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism
value down to the Parallelism
setting.
Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, Managed Service for Apache Flink can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU
times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism
value down to the Parallelism
setting.
Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled
is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism
value in response to application load. The service can increase CurrentParallelism
up to the maximum parallelism, which is ParalellismPerKPU
times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism
down to the Parallelism
setting.
Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.
', 'refs' => [ 'FlinkApplicationConfiguration$ParallelismConfiguration' => 'Describes parameters for how an application executes multiple tasks simultaneously.
', ], ], 'ParallelismConfigurationDescription' => [ 'base' => 'Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously.
', 'refs' => [ 'FlinkApplicationConfigurationDescription$ParallelismConfigurationDescription' => 'Describes parameters for how an application executes multiple tasks simultaneously.
', ], ], 'ParallelismConfigurationUpdate' => [ 'base' => 'Describes updates to parameters for how an application executes multiple tasks simultaneously.
', 'refs' => [ 'FlinkApplicationConfigurationUpdate$ParallelismConfigurationUpdate' => 'Describes updates to the parameters for how an application executes multiple tasks simultaneously.
', ], ], 'ParallelismPerKPU' => [ 'base' => NULL, 'refs' => [ 'ParallelismConfiguration$ParallelismPerKPU' => 'Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Managed Service for Apache Flink Pricing.
', 'ParallelismConfigurationDescription$ParallelismPerKPU' => 'Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.
', 'ParallelismConfigurationUpdate$ParallelismPerKPUUpdate' => 'Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.
', ], ], 'ParsedInputRecord' => [ 'base' => NULL, 'refs' => [ 'ParsedInputRecords$member' => NULL, ], ], 'ParsedInputRecordField' => [ 'base' => NULL, 'refs' => [ 'ParsedInputRecord$member' => NULL, ], ], 'ParsedInputRecords' => [ 'base' => NULL, 'refs' => [ 'DiscoverInputSchemaResponse$ParsedInputRecords' => 'An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).
', ], ], 'ProcessedInputRecord' => [ 'base' => NULL, 'refs' => [ 'ProcessedInputRecords$member' => NULL, ], ], 'ProcessedInputRecords' => [ 'base' => NULL, 'refs' => [ 'DiscoverInputSchemaResponse$ProcessedInputRecords' => 'The stream data that was modified by the processor specified in the InputProcessingConfiguration
parameter.
Stream data that was modified by the processor specified in the InputProcessingConfiguration
parameter.
Property key-value pairs passed into an application.
', 'refs' => [ 'PropertyGroups$member' => NULL, ], ], 'PropertyGroups' => [ 'base' => NULL, 'refs' => [ 'EnvironmentProperties$PropertyGroups' => 'Describes the execution property groups.
', 'EnvironmentPropertyDescriptions$PropertyGroupDescriptions' => 'Describes the execution property groups.
', 'EnvironmentPropertyUpdates$PropertyGroups' => 'Describes updates to the execution property groups.
', ], ], 'PropertyKey' => [ 'base' => NULL, 'refs' => [ 'PropertyMap$key' => NULL, ], ], 'PropertyMap' => [ 'base' => NULL, 'refs' => [ 'PropertyGroup$PropertyMap' => 'Describes the value of an application execution property key-value pair.
', ], ], 'PropertyValue' => [ 'base' => NULL, 'refs' => [ 'PropertyMap$value' => NULL, ], ], 'RawInputRecord' => [ 'base' => NULL, 'refs' => [ 'RawInputRecords$member' => NULL, ], ], 'RawInputRecords' => [ 'base' => NULL, 'refs' => [ 'DiscoverInputSchemaResponse$RawInputRecords' => 'The raw stream data that was sampled to infer the schema.
', 'UnableToDetectSchemaException$RawInputRecords' => 'Raw stream data that was sampled to infer the schema.
', ], ], 'RecordColumn' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
', 'refs' => [ 'RecordColumns$member' => NULL, ], ], 'RecordColumnDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVMappingParameters$RecordColumnDelimiter' => 'The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
', ], ], 'RecordColumnMapping' => [ 'base' => NULL, 'refs' => [ 'RecordColumn$Mapping' => 'A reference to the data element in the streaming input or the reference data source.
', ], ], 'RecordColumnName' => [ 'base' => NULL, 'refs' => [ 'RecordColumn$Name' => 'The name of the column that is created in the in-application input stream or reference table.
', ], ], 'RecordColumnSqlType' => [ 'base' => NULL, 'refs' => [ 'RecordColumn$SqlType' => 'The type of column created in the in-application input stream or reference table.
', ], ], 'RecordColumns' => [ 'base' => NULL, 'refs' => [ 'InputSchemaUpdate$RecordColumnUpdates' => 'A list of RecordColumn
objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
A list of RecordColumn
objects.
Specifies the encoding of the records in the streaming source; for example, UTF-8.
', 'SourceSchema$RecordEncoding' => 'Specifies the encoding of the records in the streaming source. For example, UTF-8.
', ], ], 'RecordFormat' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
', 'refs' => [ 'InputSchemaUpdate$RecordFormatUpdate' => 'Specifies the format of the records on the streaming source.
', 'SourceSchema$RecordFormat' => 'Specifies the format of the records on the streaming source.
', ], ], 'RecordFormatType' => [ 'base' => NULL, 'refs' => [ 'DestinationSchema$RecordFormatType' => 'Specifies the format of the records on the output stream.
', 'RecordFormat$RecordFormatType' => 'The type of record format.
', ], ], 'RecordRowDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVMappingParameters$RecordRowDelimiter' => 'The row delimiter. For example, in a CSV format, \'\\n\' is the typical row delimiter.
', ], ], 'RecordRowPath' => [ 'base' => NULL, 'refs' => [ 'JSONMappingParameters$RecordRowPath' => 'The path to the top-level parent that contains the records.
', ], ], 'ReferenceDataSource' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.
', 'refs' => [ 'AddApplicationReferenceDataSourceRequest$ReferenceDataSource' => 'The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.
', 'ReferenceDataSources$member' => NULL, ], ], 'ReferenceDataSourceDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
', 'refs' => [ 'ReferenceDataSourceDescriptions$member' => NULL, ], ], 'ReferenceDataSourceDescriptions' => [ 'base' => NULL, 'refs' => [ 'AddApplicationReferenceDataSourceResponse$ReferenceDataSourceDescriptions' => 'Describes reference data sources configured for the application.
', 'SqlApplicationConfigurationDescription$ReferenceDataSourceDescriptions' => 'The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
', ], ], 'ReferenceDataSourceUpdate' => [ 'base' => 'When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.
', 'refs' => [ 'ReferenceDataSourceUpdates$member' => NULL, ], ], 'ReferenceDataSourceUpdates' => [ 'base' => NULL, 'refs' => [ 'SqlApplicationConfigurationUpdate$ReferenceDataSourceUpdates' => 'The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.
', ], ], 'ReferenceDataSources' => [ 'base' => NULL, 'refs' => [ 'SqlApplicationConfiguration$ReferenceDataSources' => 'The array of ReferenceDataSource objects describing the reference data sources used by the application.
', ], ], 'ResourceARN' => [ 'base' => NULL, 'refs' => [ 'AddApplicationCloudWatchLoggingOptionResponse$ApplicationARN' => 'The application\'s ARN.
', 'AddApplicationInputProcessingConfigurationResponse$ApplicationARN' => 'The Amazon Resource Name (ARN) of the application.
', 'AddApplicationInputResponse$ApplicationARN' => 'The Amazon Resource Name (ARN) of the application.
', 'AddApplicationOutputResponse$ApplicationARN' => 'The application Amazon Resource Name (ARN).
', 'AddApplicationReferenceDataSourceResponse$ApplicationARN' => 'The application Amazon Resource Name (ARN).
', 'AddApplicationVpcConfigurationResponse$ApplicationARN' => 'The ARN of the application.
', 'ApplicationDetail$ApplicationARN' => 'The ARN of the application.
', 'ApplicationSummary$ApplicationARN' => 'The ARN of the application.
', 'DeleteApplicationCloudWatchLoggingOptionResponse$ApplicationARN' => 'The application\'s Amazon Resource Name (ARN).
', 'DeleteApplicationInputProcessingConfigurationResponse$ApplicationARN' => 'The Amazon Resource Name (ARN) of the application.
', 'DeleteApplicationOutputResponse$ApplicationARN' => 'The application Amazon Resource Name (ARN).
', 'DeleteApplicationReferenceDataSourceResponse$ApplicationARN' => 'The application Amazon Resource Name (ARN).
', 'DeleteApplicationVpcConfigurationResponse$ApplicationARN' => 'The ARN of the Managed Service for Apache Flink application.
', 'DiscoverInputSchemaRequest$ResourceARN' => 'The Amazon Resource Name (ARN) of the streaming source.
', 'InputLambdaProcessor$ResourceARN' => 'The ARN of the Amazon Lambda function that operates on records in the stream.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to preprocess the records in the stream.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The Amazon Resource Name (ARN) of the delivery stream.
', 'KinesisFirehoseInputDescription$ResourceARN' => 'The Amazon Resource Name (ARN) of the delivery stream.
', 'KinesisFirehoseInputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the input delivery stream to read.
', 'KinesisFirehoseOutput$ResourceARN' => 'The ARN of the destination delivery stream to write to.
', 'KinesisFirehoseOutputDescription$ResourceARN' => 'The Amazon Resource Name (ARN) of the delivery stream.
', 'KinesisFirehoseOutputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the delivery stream to write to.
', 'KinesisStreamsInput$ResourceARN' => 'The ARN of the input Kinesis data stream to read.
', 'KinesisStreamsInputDescription$ResourceARN' => 'The Amazon Resource Name (ARN) of the Kinesis data stream.
', 'KinesisStreamsInputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the input Kinesis data stream to read.
', 'KinesisStreamsOutput$ResourceARN' => 'The ARN of the destination Kinesis data stream to write to.
', 'KinesisStreamsOutputDescription$ResourceARN' => 'The Amazon Resource Name (ARN) of the Kinesis data stream.
', 'KinesisStreamsOutputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.
', 'LambdaOutput$ResourceARN' => 'The Amazon Resource Name (ARN) of the destination Lambda function to write to.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The Amazon Resource Name (ARN) of the destination Lambda function.
', 'LambdaOutputUpdate$ResourceARNUpdate' => 'The Amazon Resource Name (ARN) of the destination Amazon Lambda function.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
The Amazon Resource Name (ARN) of the application.
', ], ], 'ResourceInUseException' => [ 'base' => 'The application is not available for this operation.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'Specified application can\'t be found.
', 'refs' => [], ], 'ResourceProvisionedThroughputExceededException' => [ 'base' => 'Discovery failed to get a record from the streaming source because of the Kinesis Streams ProvisionedThroughputExceededException
. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.
Specifies the IAM role that the application uses to access external resources.
', 'CloudWatchLoggingOptionDescription$RoleARN' => 'The IAM ARN of the role to use to send application messages.
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.
', 'DiscoverInputSchemaRequest$ServiceExecutionRole' => 'The ARN of the role that is used to access the streaming source.
', 'InputLambdaProcessorDescription$RoleARN' => 'The ARN of the IAM role that is used to access the Amazon Lambda function.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
Describes updates to the service execution role.
', ], ], 'RollbackApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'RollbackApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'RunConfiguration' => [ 'base' => 'Describes the starting parameters for an Managed Service for Apache Flink application.
', 'refs' => [ 'StartApplicationRequest$RunConfiguration' => 'Identifies the run configuration (start parameters) of a Managed Service for Apache Flink application.
', ], ], 'RunConfigurationDescription' => [ 'base' => 'Describes the starting properties for a Managed Service for Apache Flink application.
', 'refs' => [ 'ApplicationConfigurationDescription$RunConfigurationDescription' => 'The details about the starting properties for a Managed Service for Apache Flink application.
', ], ], 'RunConfigurationUpdate' => [ 'base' => 'Describes the updates to the starting parameters for a Managed Service for Apache Flink application.
', 'refs' => [ 'UpdateApplicationRequest$RunConfigurationUpdate' => 'Describes updates to the application\'s starting parameters.
', ], ], 'RuntimeEnvironment' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$RuntimeEnvironment' => 'The runtime environment for the application.
', 'ApplicationSummary$RuntimeEnvironment' => 'The runtime environment for the application.
', 'CreateApplicationRequest$RuntimeEnvironment' => 'The runtime environment for the application.
', 'SnapshotDetails$RuntimeEnvironment' => 'The Flink Runtime for the application snapshot.
', 'UpdateApplicationRequest$RuntimeEnvironmentUpdate' => 'Updates the Managed Service for Apache Flink runtime environment used to run your code. To avoid issues you must:
Ensure your new jar and dependencies are compatible with the new runtime selected.
Ensure your new code\'s state is compatible with the snapshot from which your application will start
Describes the location of an application\'s code stored in an S3 bucket.
', 'refs' => [ 'CodeContentDescription$S3ApplicationCodeLocationDescription' => 'The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
', ], ], 'S3Configuration' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name of the Amazon S3 object that contains the data.
', 'refs' => [ 'DiscoverInputSchemaRequest$S3Configuration' => 'Specify this parameter to discover a schema from data in an Amazon S3 object.
', ], ], 'S3ContentBaseLocation' => [ 'base' => 'The S3 bucket that holds the application information.
', 'refs' => [ 'DeployAsApplicationConfiguration$S3ContentLocation' => 'The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
', ], ], 'S3ContentBaseLocationDescription' => [ 'base' => 'The description of the S3 base location that holds the application.
', 'refs' => [ 'DeployAsApplicationConfigurationDescription$S3ContentLocationDescription' => 'The location that holds the data required to specify an Amazon Data Analytics application.
', ], ], 'S3ContentBaseLocationUpdate' => [ 'base' => 'The information required to update the S3 base location that holds the application.
', 'refs' => [ 'DeployAsApplicationConfigurationUpdate$S3ContentLocationUpdate' => 'Updates to the location that holds the data required to specify an Amazon Data Analytics application.
', ], ], 'S3ContentLocation' => [ 'base' => 'For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
', 'refs' => [ 'CodeContent$S3ContentLocation' => 'Information about the Amazon S3 bucket that contains the application code.
', 'CustomArtifactConfiguration$S3ContentLocation' => NULL, 'CustomArtifactConfigurationDescription$S3ContentLocationDescription' => NULL, ], ], 'S3ContentLocationUpdate' => [ 'base' => 'Describes an update for the Amazon S3 code content location for an application.
', 'refs' => [ 'CodeContentUpdate$S3ContentLocationUpdate' => 'Describes an update to the location of code for an application.
', ], ], 'S3ReferenceDataSource' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data.
A SQL-based Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
', 'refs' => [ 'ReferenceDataSource$S3ReferenceDataSource' => 'Identifies the S3 bucket and object that contains the reference data. A SQL-based Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
', ], ], 'S3ReferenceDataSourceDescription' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.
', 'refs' => [ 'ReferenceDataSourceDescription$S3ReferenceDataSourceDescription' => 'Provides the Amazon S3 bucket name, the object key name that contains the reference data.
', ], ], 'S3ReferenceDataSourceUpdate' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.
', 'refs' => [ 'ReferenceDataSourceUpdate$S3ReferenceDataSourceUpdate' => 'Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfiguration$SecurityGroupIds' => 'The array of SecurityGroup IDs used by the VPC configuration.
', 'VpcConfigurationDescription$SecurityGroupIds' => 'The array of SecurityGroup IDs used by the VPC configuration.
', 'VpcConfigurationUpdate$SecurityGroupIdUpdates' => 'Describes updates to the array of SecurityGroup IDs used by the VPC configuration.
', ], ], 'ServiceUnavailableException' => [ 'base' => 'The service cannot complete the request.
', 'refs' => [], ], 'SessionExpirationDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationPresignedUrlRequest$SessionExpirationDurationInSeconds' => 'The duration in seconds for which the returned URL will be valid.
', ], ], 'SnapshotDetails' => [ 'base' => 'Provides details about a snapshot of application state.
', 'refs' => [ 'DescribeApplicationSnapshotResponse$SnapshotDetails' => 'An object containing information about the application snapshot.
', 'SnapshotSummaries$member' => NULL, ], ], 'SnapshotName' => [ 'base' => NULL, 'refs' => [ 'ApplicationRestoreConfiguration$SnapshotName' => 'The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT
is specified for the ApplicationRestoreType
.
An identifier for the application snapshot.
', 'DeleteApplicationSnapshotRequest$SnapshotName' => 'The identifier for the snapshot delete.
', 'DescribeApplicationSnapshotRequest$SnapshotName' => 'The identifier of an application snapshot. You can retrieve this value using .
', 'SnapshotDetails$SnapshotName' => 'The identifier for the application snapshot.
', ], ], 'SnapshotStatus' => [ 'base' => NULL, 'refs' => [ 'SnapshotDetails$SnapshotStatus' => 'The status of the application snapshot.
', ], ], 'SnapshotSummaries' => [ 'base' => NULL, 'refs' => [ 'ListApplicationSnapshotsResponse$SnapshotSummaries' => 'A collection of objects containing information about the application snapshots.
', ], ], 'SourceSchema' => [ 'base' => 'For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
', 'refs' => [ 'DiscoverInputSchemaResponse$InputSchema' => 'The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.
', 'Input$InputSchema' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
Also used to describe the format of the reference data source.
', 'InputDescription$InputSchema' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
', 'ReferenceDataSource$ReferenceSchema' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
', 'ReferenceDataSourceDescription$ReferenceSchema' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
', 'ReferenceDataSourceUpdate$ReferenceSchemaUpdate' => 'Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
', ], ], 'SqlApplicationConfiguration' => [ 'base' => 'Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'ApplicationConfiguration$SqlApplicationConfiguration' => 'The creation and update parameters for a SQL-based Kinesis Data Analytics application.
', ], ], 'SqlApplicationConfigurationDescription' => [ 'base' => 'Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'ApplicationConfigurationDescription$SqlApplicationConfigurationDescription' => 'The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
', ], ], 'SqlApplicationConfigurationUpdate' => [ 'base' => 'Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'ApplicationConfigurationUpdate$SqlApplicationConfigurationUpdate' => 'Describes updates to a SQL-based Kinesis Data Analytics application\'s configuration.
', ], ], 'SqlRunConfiguration' => [ 'base' => 'Describes the starting parameters for a SQL-based Kinesis Data Analytics application.
', 'refs' => [ 'SqlRunConfigurations$member' => NULL, ], ], 'SqlRunConfigurations' => [ 'base' => NULL, 'refs' => [ 'RunConfiguration$SqlRunConfigurations' => 'Describes the starting parameters for a SQL-based Kinesis Data Analytics application application.
', ], ], 'StartApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfiguration$SubnetIds' => 'The array of Subnet IDs used by the VPC configuration.
', 'VpcConfigurationDescription$SubnetIds' => 'The array of Subnet IDs used by the VPC configuration.
', 'VpcConfigurationUpdate$SubnetIdUpdates' => 'Describes updates to the array of Subnet IDs used by the VPC configuration.
', ], ], 'Tag' => [ 'base' => 'A key-value pair (the value is optional) that you can define and assign to Amazon resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key of the key-value tag.
', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => 'A list of keys of tags to remove from the specified application.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value of the key-value tag. The value is optional.
', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationRequest$Tags' => 'A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
', 'ListTagsForResourceResponse$Tags' => 'The key-value tags assigned to the application.
', 'TagResourceRequest$Tags' => 'The key-value tags to assign to the application.
', ], ], 'TextContent' => [ 'base' => NULL, 'refs' => [ 'CodeContent$TextContent' => 'The text-format code for a Managed Service for Apache Flink application.
', 'CodeContentDescription$TextContent' => 'The text-format code
', 'CodeContentUpdate$TextContentUpdate' => 'Describes an update to the text code for an application.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ApplicationDetail$CreateTimestamp' => 'The current timestamp when the application was created.
', 'ApplicationDetail$LastUpdateTimestamp' => 'The current timestamp when the application was last updated.
', 'ApplicationDetail$ApplicationVersionCreateTimestamp' => 'The current timestamp when the application version was created.', 'ApplicationOperationInfo$StartTime' => 'The timestamp at which the operation was created', 'ApplicationOperationInfo$EndTime' => 'The timestamp at which the operation finished for the application', 'ApplicationOperationInfoDetails$StartTime' => 'The timestamp at which the operation was created', 'ApplicationOperationInfoDetails$EndTime' => 'The timestamp at which the operation finished for the application', 'DeleteApplicationRequest$CreateTimestamp' => 'Use the DescribeApplication
operation to get this value.
The creation timestamp of the application snapshot to delete. You can retrieve this value using or .
', 'SnapshotDetails$SnapshotCreationTimestamp' => 'The timestamp of the application snapshot.
', ], ], 'TooManyTagsException' => [ 'base' => 'Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
', 'refs' => [], ], 'UnableToDetectSchemaException' => [ 'base' => 'The data format is not valid. Kinesis Data Analytics cannot detect the schema for the given streaming source.
', 'refs' => [], ], 'UnsupportedOperationException' => [ 'base' => 'The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationMaintenanceConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationMaintenanceConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateApplicationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UrlType' => [ 'base' => NULL, 'refs' => [ 'CreateApplicationPresignedUrlRequest$UrlType' => 'The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is FLINK_DASHBOARD_URL
.
Describes the parameters of a VPC used by the application.
', 'refs' => [ 'AddApplicationVpcConfigurationRequest$VpcConfiguration' => 'Description of the VPC to add to the application.
', 'VpcConfigurations$member' => NULL, ], ], 'VpcConfigurationDescription' => [ 'base' => 'Describes the parameters of a VPC used by the application.
', 'refs' => [ 'AddApplicationVpcConfigurationResponse$VpcConfigurationDescription' => 'The parameters of the new VPC configuration.
', 'VpcConfigurationDescriptions$member' => NULL, ], ], 'VpcConfigurationDescriptions' => [ 'base' => NULL, 'refs' => [ 'ApplicationConfigurationDescription$VpcConfigurationDescriptions' => 'The array of descriptions of VPC configurations available to the application.
', ], ], 'VpcConfigurationUpdate' => [ 'base' => 'Describes updates to the VPC configuration used by the application.
', 'refs' => [ 'VpcConfigurationUpdates$member' => NULL, ], ], 'VpcConfigurationUpdates' => [ 'base' => NULL, 'refs' => [ 'ApplicationConfigurationUpdate$VpcConfigurationUpdates' => 'Updates to the array of descriptions of VPC configurations available to the application.
', ], ], 'VpcConfigurations' => [ 'base' => NULL, 'refs' => [ 'ApplicationConfiguration$VpcConfigurations' => 'The array of descriptions of VPC configurations available to the application.
', ], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'VpcConfigurationDescription$VpcId' => 'The ID of the associated VPC.
', ], ], 'ZeppelinApplicationConfiguration' => [ 'base' => 'The configuration of a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ApplicationConfiguration$ZeppelinApplicationConfiguration' => 'The configuration parameters for a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinApplicationConfigurationDescription' => [ 'base' => 'The configuration of a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ApplicationConfigurationDescription$ZeppelinApplicationConfigurationDescription' => 'The configuration parameters for a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinApplicationConfigurationUpdate' => [ 'base' => 'Updates to the configuration of Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ApplicationConfigurationUpdate$ZeppelinApplicationConfigurationUpdate' => 'Updates to the configuration of a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinMonitoringConfiguration' => [ 'base' => 'Describes configuration parameters for Amazon CloudWatch logging for a Managed Service for Apache Flink Studio notebook. For more information about CloudWatch logging, see Monitoring.
', 'refs' => [ 'ZeppelinApplicationConfiguration$MonitoringConfiguration' => 'The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinMonitoringConfigurationDescription' => [ 'base' => 'The monitoring configuration for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfigurationDescription$MonitoringConfigurationDescription' => 'The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZeppelinMonitoringConfigurationUpdate' => [ 'base' => 'Updates to the monitoring configuration for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
', 'refs' => [ 'ZeppelinApplicationConfigurationUpdate$MonitoringConfigurationUpdate' => 'Updates to the monitoring configuration of a Managed Service for Apache Flink Studio notebook.
', ], ], 'ZipFileContent' => [ 'base' => NULL, 'refs' => [ 'CodeContent$ZipFileContent' => 'The zip-format code for a Managed Service for Apache Flink application.
', 'CodeContentUpdate$ZipFileContentUpdate' => 'Describes an update to the zipped code for an application.
', ], ], ],]; diff --git a/src/data/opensearch/2021-01-01/api-2.json b/src/data/opensearch/2021-01-01/api-2.json index b1bae1abcc..ae094168fe 100644 --- a/src/data/opensearch/2021-01-01/api-2.json +++ b/src/data/opensearch/2021-01-01/api-2.json @@ -1000,25 +1000,6 @@ } }, "shapes":{ - "AIMLOptionsInput":{ - "type":"structure", - "members":{ - "NaturalLanguageQueryGenerationOptions":{"shape":"NaturalLanguageQueryGenerationOptionsInput"} - } - }, - "AIMLOptionsOutput":{ - "type":"structure", - "members":{ - "NaturalLanguageQueryGenerationOptions":{"shape":"NaturalLanguageQueryGenerationOptionsOutput"} - } - }, - "AIMLOptionsStatus":{ - "type":"structure", - "members":{ - "Options":{"shape":"AIMLOptionsOutput"}, - "Status":{"shape":"OptionStatus"} - } - }, "ARN":{ "type":"string", "max":2048, @@ -1638,8 +1619,7 @@ "TagList":{"shape":"TagList"}, "AutoTuneOptions":{"shape":"AutoTuneOptionsInput"}, "OffPeakWindowOptions":{"shape":"OffPeakWindowOptions"}, - "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"}, - "AIMLOptions":{"shape":"AIMLOptionsInput"} + "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"} } }, "CreateDomainResponse":{ @@ -2298,8 +2278,7 @@ "ChangeProgressDetails":{"shape":"ChangeProgressDetails"}, "OffPeakWindowOptions":{"shape":"OffPeakWindowOptionsStatus"}, "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptionsStatus"}, - "ModifyingProperties":{"shape":"ModifyingPropertiesList"}, - "AIMLOptions":{"shape":"AIMLOptionsStatus"} + "ModifyingProperties":{"shape":"ModifyingPropertiesList"} } }, "DomainEndpointOptions":{ @@ -2492,8 +2471,7 @@ "OffPeakWindowOptions":{"shape":"OffPeakWindowOptions"}, "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"}, "DomainProcessingStatus":{"shape":"DomainProcessingStatusType"}, - "ModifyingProperties":{"shape":"ModifyingPropertiesList"}, - "AIMLOptions":{"shape":"AIMLOptionsOutput"} + "ModifyingProperties":{"shape":"ModifyingPropertiesList"} } }, "DomainStatusList":{ @@ -3387,38 +3365,6 @@ "type":"list", "member":{"shape":"ModifyingProperties"} }, - "NaturalLanguageQueryGenerationCurrentState":{ - "type":"string", - "enum":[ - "NOT_ENABLED", - "ENABLE_COMPLETE", - "ENABLE_IN_PROGRESS", - "ENABLE_FAILED", - "DISABLE_COMPLETE", - "DISABLE_IN_PROGRESS", - "DISABLE_FAILED" - ] - }, - "NaturalLanguageQueryGenerationDesiredState":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "NaturalLanguageQueryGenerationOptionsInput":{ - "type":"structure", - "members":{ - "DesiredState":{"shape":"NaturalLanguageQueryGenerationDesiredState"} - } - }, - "NaturalLanguageQueryGenerationOptionsOutput":{ - "type":"structure", - "members":{ - "DesiredState":{"shape":"NaturalLanguageQueryGenerationDesiredState"}, - "CurrentState":{"shape":"NaturalLanguageQueryGenerationCurrentState"} - } - }, "NextToken":{"type":"string"}, "NodeId":{ "type":"string", @@ -4363,8 +4309,7 @@ "DryRun":{"shape":"DryRun"}, "DryRunMode":{"shape":"DryRunMode"}, "OffPeakWindowOptions":{"shape":"OffPeakWindowOptions"}, - "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"}, - "AIMLOptions":{"shape":"AIMLOptionsInput"} + "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"} } }, "UpdateDomainConfigResponse":{ 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 852cfd0f1a..d0af5b3855 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', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Amazon OpenSearch Service', 'serviceId' => 'OpenSearch', 'signatureVersion' => 'v4', 'uid' => 'opensearch-2021-01-01', 'auth' => [ 'aws.auth#sigv4', ], ], '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' => [ 'AIMLOptionsInput' => [ 'type' => 'structure', 'members' => [ 'NaturalLanguageQueryGenerationOptions' => [ 'shape' => 'NaturalLanguageQueryGenerationOptionsInput', ], ], ], 'AIMLOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'NaturalLanguageQueryGenerationOptions' => [ 'shape' => 'NaturalLanguageQueryGenerationOptionsOutput', ], ], ], 'AIMLOptionsStatus' => [ 'type' => 'structure', 'members' => [ 'Options' => [ 'shape' => 'AIMLOptionsOutput', ], 'Status' => [ 'shape' => 'OptionStatus', ], ], ], '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', ], 'JWTOptions' => [ 'shape' => 'JWTOptionsOutput', ], 'AnonymousAuthDisableDate' => [ 'shape' => 'DisableTimestamp', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'MasterUserOptions' => [ 'shape' => 'MasterUserOptions', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsInput', ], 'JWTOptions' => [ 'shape' => 'JWTOptionsInput', ], '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', ], 'AIMLOptions' => [ 'shape' => 'AIMLOptionsInput', ], ], ], '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', ], 'Status' => [ 'shape' => 'DataSourceStatus', ], ], ], 'DataSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceDetails', ], ], 'DataSourceName' => [ 'type' => 'string', 'max' => 80, 'min' => 3, 'pattern' => '[a-z][a-z0-9_]+', ], 'DataSourceStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DISABLED', ], ], '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', ], 'AIMLOptions' => [ 'shape' => 'AIMLOptionsStatus', ], ], ], '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', ], 'AIMLOptions' => [ 'shape' => 'AIMLOptionsOutput', ], ], ], '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', ], 'Status' => [ 'shape' => 'DataSourceStatus', ], ], ], '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', ], ], 'JWTOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'SubjectKey' => [ 'shape' => 'SubjectKey', ], 'RolesKey' => [ 'shape' => 'RolesKey', ], 'PublicKey' => [ 'shape' => 'String', ], ], ], 'JWTOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'PublicKey' => [ 'shape' => 'String', ], ], ], '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', ], ], 'NaturalLanguageQueryGenerationCurrentState' => [ 'type' => 'string', 'enum' => [ 'NOT_ENABLED', 'ENABLE_COMPLETE', 'ENABLE_IN_PROGRESS', 'ENABLE_FAILED', 'DISABLE_COMPLETE', 'DISABLE_IN_PROGRESS', 'DISABLE_FAILED', ], ], 'NaturalLanguageQueryGenerationDesiredState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', ], ], 'NaturalLanguageQueryGenerationOptionsInput' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'NaturalLanguageQueryGenerationDesiredState', ], ], ], 'NaturalLanguageQueryGenerationOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'DesiredState' => [ 'shape' => 'NaturalLanguageQueryGenerationDesiredState', ], 'CurrentState' => [ 'shape' => 'NaturalLanguageQueryGenerationCurrentState', ], ], ], '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\\/.*', ], 'RolesKey' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], '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', ], ], 'SubjectKey' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], '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', ], 'Status' => [ 'shape' => 'DataSourceStatus', ], ], ], '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', ], 'AIMLOptions' => [ 'shape' => 'AIMLOptionsInput', ], ], ], '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', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Amazon OpenSearch Service', 'serviceId' => 'OpenSearch', 'signatureVersion' => 'v4', 'uid' => 'opensearch-2021-01-01', 'auth' => [ 'aws.auth#sigv4', ], ], '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', ], 'JWTOptions' => [ 'shape' => 'JWTOptionsOutput', ], 'AnonymousAuthDisableDate' => [ 'shape' => 'DisableTimestamp', ], 'AnonymousAuthEnabled' => [ 'shape' => 'Boolean', ], ], ], 'AdvancedSecurityOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'InternalUserDatabaseEnabled' => [ 'shape' => 'Boolean', ], 'MasterUserOptions' => [ 'shape' => 'MasterUserOptions', ], 'SAMLOptions' => [ 'shape' => 'SAMLOptionsInput', ], 'JWTOptions' => [ 'shape' => 'JWTOptionsInput', ], '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', ], 'Status' => [ 'shape' => 'DataSourceStatus', ], ], ], 'DataSourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DataSourceDetails', ], ], 'DataSourceName' => [ 'type' => 'string', 'max' => 80, 'min' => 3, 'pattern' => '[a-z][a-z0-9_]+', ], 'DataSourceStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'DISABLED', ], ], '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', ], 'Status' => [ 'shape' => 'DataSourceStatus', ], ], ], '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', ], ], 'JWTOptionsInput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'SubjectKey' => [ 'shape' => 'SubjectKey', ], 'RolesKey' => [ 'shape' => 'RolesKey', ], 'PublicKey' => [ 'shape' => 'String', ], ], ], 'JWTOptionsOutput' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'Boolean', ], 'SubjectKey' => [ 'shape' => 'String', ], 'RolesKey' => [ 'shape' => 'String', ], 'PublicKey' => [ 'shape' => 'String', ], ], ], '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\\/.*', ], 'RolesKey' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], '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', ], ], 'SubjectKey' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], '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', ], 'Status' => [ 'shape' => 'DataSourceStatus', ], ], ], '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 41f9e3dbba..af8019750e 100644 --- a/src/data/opensearch/2021-01-01/docs-2.json +++ b/src/data/opensearch/2021-01-01/docs-2.json @@ -67,26 +67,6 @@ "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": { - "AIMLOptionsInput": { - "base": "Container for parameters required to enable all machine learning features.
", - "refs": { - "CreateDomainRequest$AIMLOptions": "Options for all machine learning features for the specified domain.
", - "UpdateDomainConfigRequest$AIMLOptions": "Options for all machine learning features for the specified domain.
" - } - }, - "AIMLOptionsOutput": { - "base": "Container for parameters representing the state of machine learning features on the specified domain.
", - "refs": { - "AIMLOptionsStatus$Options": "Machine learning options on the specified domain.
", - "DomainStatus$AIMLOptions": "Container for parameters required to enable all machine learning features.
" - } - }, - "AIMLOptionsStatus": { - "base": "The status of machine learning options on the specified domain.
", - "refs": { - "DomainConfig$AIMLOptions": "Container for parameters required to enable all machine learning features.
" - } - }, "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": { @@ -1914,31 +1894,6 @@ "DomainStatus$ModifyingProperties": "Information about the domain properties that are currently being modified.
" } }, - "NaturalLanguageQueryGenerationCurrentState": { - "base": null, - "refs": { - "NaturalLanguageQueryGenerationOptionsOutput$CurrentState": "The current state of the natural language query generation feature, indicating completion, in progress, or failure.
" - } - }, - "NaturalLanguageQueryGenerationDesiredState": { - "base": null, - "refs": { - "NaturalLanguageQueryGenerationOptionsInput$DesiredState": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
", - "NaturalLanguageQueryGenerationOptionsOutput$DesiredState": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
" - } - }, - "NaturalLanguageQueryGenerationOptionsInput": { - "base": "Container for parameters required to enable the natural language query generation feature.
", - "refs": { - "AIMLOptionsInput$NaturalLanguageQueryGenerationOptions": "Container for parameters required for natural language query generation on the specified domain.
" - } - }, - "NaturalLanguageQueryGenerationOptionsOutput": { - "base": "Container for parameters representing the state of the natural language query generation feature on the specified domain.
", - "refs": { - "AIMLOptionsOutput$NaturalLanguageQueryGenerationOptions": "Container for parameters required for natural language query generation on the specified domain.
" - } - }, "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.
Provides the current status of an entity.
", "refs": { - "AIMLOptionsStatus$Status": null, "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.
", 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 edb0814415..2aaf0c5b51 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.
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' => [ 'AIMLOptionsInput' => [ 'base' => 'Container for parameters required to enable all machine learning features.
', 'refs' => [ 'CreateDomainRequest$AIMLOptions' => 'Options for all machine learning features for the specified domain.
', 'UpdateDomainConfigRequest$AIMLOptions' => 'Options for all machine learning features for the specified domain.
', ], ], 'AIMLOptionsOutput' => [ 'base' => 'Container for parameters representing the state of machine learning features on the specified domain.
', 'refs' => [ 'AIMLOptionsStatus$Options' => 'Machine learning options on the specified domain.
', 'DomainStatus$AIMLOptions' => 'Container for parameters required to enable all machine learning features.
', ], ], 'AIMLOptionsStatus' => [ 'base' => 'The status of machine learning options on the specified domain.
', 'refs' => [ 'DomainConfig$AIMLOptions' => 'Container for parameters required to enable all machine learning features.
', ], ], '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
.
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.
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.
Container for the parameters to the AddDataSource
operation.
The result of an AddDataSource
operation.
Container for the parameters to the AddTags
operation. Specifies the tags to attach to the domain.
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:
Allows references to indexes in an HTTP request body. Must be false
when configuring access to individual sub-resources. Default is true
.
Specifies the percentage of heap space allocated to field data. Default is unbounded.
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:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses
error.
"override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
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:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses
error.
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.
The advanced options configuration for the domain.
', ], ], 'AdvancedOptionsStatus' => [ 'base' => 'Status of the advanced options for the specified domain. The following options are available:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses
error.
"override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
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.
Container for the response returned by the AssociatePackage
operation.
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.
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.
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.
', 'JWTOptionsInput$Enabled' => 'True to enable JWT authentication and authorization for a domain.
', 'JWTOptionsOutput$Enabled' => 'True if JWT use is enabled.
', '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.
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
.
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.
DIRECT - Used for cross-cluster search or cross-cluster replication.
VPC_ENDPOINT - Used for remote reindex between Amazon OpenSearch Service VPC domains.
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.
The ConnectionProperties
for the newly created connection.
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.
Container for the parameters to the CreateOutboundConnection
operation.
The result of a CreateOutboundConnection
request. Contains details about the newly created cross-cluster connection.
Container for request parameters to the CreatePackage
operation.
Container for the response returned by the CreatePackage
operation.
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.
', ], ], 'DataSourceStatus' => [ 'base' => NULL, 'refs' => [ 'DataSourceDetails$Status' => 'The status of the data source.
', 'GetDataSourceResponse$Status' => 'The status of the data source.
', 'UpdateDataSourceRequest$Status' => 'The status of the data source update.
', ], ], '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.
The result of a GetDataSource
operation.
Container for the parameters to the DeleteDomain
operation.
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.
Container for the parameters to the DeleteInboundConnection
operation.
The results of a DeleteInboundConnection
operation. Contains details about the deleted inbound connection.
Container for the parameters to the DeleteOutboundConnection
operation.
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.
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:
Blue/Green - The update requires a blue/green deployment.
DynamicUpdate - No blue/green deployment required
Undetermined - The domain is in the middle of an update and can\'t predict the deployment type. Try again after the update is complete.
None - The request doesn\'t include any configuration changes.
Container for the parameters to the DescribeDomainAutoTunes
operation.
The result of a DescribeDomainAutoTunes
request.
Container for the parameters to the DescribeDomainChangeProgress
operation.
The result of a DescribeDomainChangeProgress
request. Contains progress information for the requested domain change.
Container for the parameters to the DescribeDomainConfig
operation.
Contains the configuration information of the requested domain.
', 'refs' => [], ], 'DescribeDomainHealthRequest' => [ 'base' => 'Container for the parameters to the DescribeDomainHealth
operation.
The result of a DescribeDomainHealth
request. Contains health information for the requested domain.
Container for the parameters to the DescribeDomainNodes
operation.
The result of a DescribeDomainNodes
request. Contains information about the nodes on the requested domain.
Container for the parameters to the DescribeDomain
operation.
Contains the status of the domain specified in the request.
', 'refs' => [], ], 'DescribeDomainsRequest' => [ 'base' => 'Container for the parameters to the DescribeDomains
operation.
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.
Contains a list of connections matching the filter criteria.
', 'refs' => [], ], 'DescribeInstanceTypeLimitsRequest' => [ 'base' => 'Container for the parameters to the DescribeInstanceTypeLimits
operation.
Container for the parameters received from the DescribeInstanceTypeLimits
operation.
Container for the parameters to the DescribeOutboundConnections
operation.
Contains a list of connections matching the filter criteria.
', 'refs' => [], ], 'DescribePackagesFilter' => [ 'base' => 'A filter to apply to the DescribePackage
response.
A list of DescribePackagesFilter
to filter the packages included in a DescribePackages
response.
Only returns packages that match the DescribePackagesFilterList
values.
Any field from PackageDetails
.
A non-empty list of values for the specified filter field.
', ], ], 'DescribePackagesRequest' => [ 'base' => 'Container for the request parameters to the DescribePackage
operation.
Container for the response returned by the DescribePackages
operation.
Container for the request parameters to a DescribeReservedInstanceOfferings
operation.
Container for results of a DescribeReservedInstanceOfferings
request.
Container for the request parameters to the DescribeReservedInstances
operation.
Container for results from DescribeReservedInstances
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.
Container for the response returned by an DissociatePackage
operation.
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.
Red
- At least one primary shard is not allocated to any node.
Yellow
- All primary shards are allocated to nodes, but some replicas aren’t.
Green
- All primary shards and their replicas are allocated to nodes.
NotAvailable
- Unable to retrieve cluster health.
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.
Contains nodes information list DomainNodesStatusList
with details about the all nodes on the requested domain.
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.
Processing
- The domain has updates in progress.
Active
- Requested changes have been processed and deployed to the domain.
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.
Whether or not the request was a dry run. If True
, the changes were not actually cancelled.
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.
The type of dry run to perform.
Basic
only returns the type of deployment (blue/green or dynamic) that the update will cause.
Verbose
runs an additional check to validate the changes you\'re making. For more information, see Validating a domain update.
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"}
.
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:
IPv4 IP addresses - \'vpc\',\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\'
Dual stack IP addresses - \'vpcv2\':\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws\'
The type of search engine that the domain is running.OpenSearch
for an OpenSearch engine, or Elasticsearch
for a legacy Elasticsearch OSS engine.
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.
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.
Container for the response returned by the GetCompatibleVersions
operation.
Container for the parameters to the GetDataSource
operation.
The result of a GetDataSource
operation.
Container for the parameters to the GetDomainMaintenanceStatus
operation.
The result of a GetDomainMaintenanceStatus
request that information about the requested action.
Container for the request parameters to the GetPackageVersionHistory
operation.
Container for response returned by GetPackageVersionHistory
operation.
Container for the request parameters to the GetUpgradeHistory
operation.
Container for the response returned by the GetUpgradeHistory
operation.
Container for the request parameters to the GetUpgradeStatus
operation.
Container for the response returned by the GetUpgradeStatus
operation.
The dual stack 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:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
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.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3
volume type.
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.
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.
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.
', ], ], 'JWTOptionsInput' => [ 'base' => 'The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.
', 'refs' => [ 'AdvancedSecurityOptionsInput$JWTOptions' => 'Container for information about the JWT configuration of the Amazon OpenSearch Service.
', ], ], 'JWTOptionsOutput' => [ 'base' => 'Describes the JWT options configured for the domain.
', 'refs' => [ 'AdvancedSecurityOptions$JWTOptions' => 'Container for information about the JWT configuration of the Amazon OpenSearch Service.
', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => 'The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
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' => ' MaximumNumberOfDataNodesSupported
- This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support.
MaximumNumberOfDataNodesWithoutMasterNode
- This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.
Name of storage limits that are applicable for the given storage type. If StorageType
is ebs
, the following options are available:
MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
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:
data - A data node.
master - A dedicated master node.
ultra_warm - An UltraWarm node.
Map that contains all applicable instance type limits.data
refers to data nodes.master
refers to dedicated master nodes.
Container for the parameters to the ListDataSources
operation.
The result of a ListDataSources
operation.
Container for the parameters to the ListDomainMaintenances
operation.
The result of a ListDomainMaintenances
request that contains information about the requested actions.
Container for the parameters to the ListDomainNames
operation.
The results of a ListDomainNames
operation. Contains the names of all domains owned by this account and their respective engine types.
Container for the request parameters to the ListDomainsForPackage
operation.
Container for the response parameters to the ListDomainsForPackage
operation.
Container for the request parameters to the ListPackagesForDomain
operation.
Container for the response parameters to the ListPackagesForDomain
operation.
Container for the parameters to the ListTags
operation.
The results of a ListTags
operation.
Container for the request parameters to the ListVersions
operation.
Container for the parameters for response received from the ListVersions
operation.
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.
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:
INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.
SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.
ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.
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
.
The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt
to TIMESTAMP
.
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.
Available - The domain has an elected master node.
UnAvailable - The master node hasn\'t yet been elected, and a quorum to elect a new master node hasn\'t been reached.
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.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
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.
', ], ], 'NaturalLanguageQueryGenerationCurrentState' => [ 'base' => NULL, 'refs' => [ 'NaturalLanguageQueryGenerationOptionsOutput$CurrentState' => 'The current state of the natural language query generation feature, indicating completion, in progress, or failure.
', ], ], 'NaturalLanguageQueryGenerationDesiredState' => [ 'base' => NULL, 'refs' => [ 'NaturalLanguageQueryGenerationOptionsInput$DesiredState' => 'The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
', 'NaturalLanguageQueryGenerationOptionsOutput$DesiredState' => 'The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
', ], ], 'NaturalLanguageQueryGenerationOptionsInput' => [ 'base' => 'Container for parameters required to enable the natural language query generation feature.
', 'refs' => [ 'AIMLOptionsInput$NaturalLanguageQueryGenerationOptions' => 'Container for parameters required for natural language query generation on the specified domain.
', ], ], 'NaturalLanguageQueryGenerationOptionsOutput' => [ 'base' => 'Container for parameters representing the state of the natural language query generation feature on the specified domain.
', 'refs' => [ 'AIMLOptionsOutput$NaturalLanguageQueryGenerationOptions' => 'Container for parameters required for natural language query generation on the specified domain.
', ], ], '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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
If your initial ListDomainMaintenances
operation returns a nextToken
, include the returned nextToken
in subsequent ListDomainMaintenances
operations, which returns results in the next page.
When nextToken
is returned, there are more results available. The value of nextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
.
The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable
.
The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable
.
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
.
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
.
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:
Processing - The requested change is still in progress.
Active - The requested change is processed and deployed to the domain.
The state of the entity.
', ], ], 'OptionStatus' => [ 'base' => 'Provides the current status of an entity.
', 'refs' => [ 'AIMLOptionsStatus$Status' => NULL, '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:
VALIDATING - The outbound connection request is being validated.
VALIDATION_FAILED - Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
PROVISIONING - Outbound connection request is in process.
ACTIVE - Outbound connection is active and ready to use.
REJECTING - Outbound connection rejection by remote domain owner is in progress.
REJECTED - Outbound connection request is rejected by remote domain owner.
DELETING - Outbound connection deletion is in progress.
DELETED - Outbound connection is deleted and can no longer be used.
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.
The internal ID of the package you want to delete. Use DescribePackages
to find this value.
Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain
to find this value.
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
.
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
.
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.
Additional information about plugin properties if the package is a ZIP-PLUGIN
package.
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:
PLAIN_TEXT
: Contain direct values such as "1", "True", or "c5.large.search".
STRINGIFIED_JSON
: Contain content in JSON format, such as {"Enabled":"True"}".
Container for request parameters to the PurchaseReservedInstanceOffering
operation.
Represents the output of a PurchaseReservedInstanceOffering
operation.
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.
The Amazon Web Services Region in which the domain is located.
', ], ], 'RejectInboundConnectionRequest' => [ 'base' => 'Container for the request parameters to the RejectInboundConnection
operation.
Represents the output of a RejectInboundConnection
operation.
Container for the request parameters to the RemoveTags
operation.
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.
>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
', ], ], 'RolesKey' => [ 'base' => NULL, 'refs' => [ 'JWTOptionsInput$RolesKey' => 'Element of the JWT assertion to use for roles.
', ], ], '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.
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.
NOW
- Immediately schedules the update to happen in the current hour if there\'s capacity available.
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime
.
OFF_PEAK_WINDOW
- Marks the update to be picked up during an upcoming off-peak window. There\'s no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
Default: NOW
if you don\'t specify a value for DesiredStartTime
, and TIMESTAMP
if you do.
When to schedule the action.
NOW
- Immediately schedules the update to happen in the current hour if there\'s capacity available.
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime
.
OFF_PEAK_WINDOW
- Marks the action to be picked up during an upcoming off-peak window. There\'s no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.
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
.
Whether the action was scheduled manually (CUSTOMER
, or by OpenSearch Service automatically (SYSTEM
).
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
.
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.
The status of SkipUnavailable
setting for the outbound connection.
ENABLED - The SkipUnavailable
setting is enabled for the connection.
DISABLED - The SkipUnavailable
setting is disabled for the connection.
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.
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.
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.
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.
The result of a StartDomainMaintenance
request that information about the requested action.
Container for the request parameters to the StartServiceSoftwareUpdate
operation.
Represents the output of a StartServiceSoftwareUpdate
operation. Contains the status of the update.
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.
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
.
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:
standard
gp2
gp3
io1
The storage sub-type, such as gp3
or io1
.
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:
Built-in storage available for the instance.
Elastic Block Storage (EBS) attached to the instance.
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.
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.
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.
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.
Element of the JWT assertion used by the cluster to verify JWT signatures.
', 'JWTOptionsOutput$SubjectKey' => 'The key used for matching the JWT subject attribute.
', 'JWTOptionsOutput$RolesKey' => 'The key used for matching the JWT roles attribute.
', 'JWTOptionsOutput$PublicKey' => 'The key used to verify the signature of incoming JWT requests.
', '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.
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.
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
.
Element of the SAML assertion to use for backend roles. Default is roles
.
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.
', ], ], 'SubjectKey' => [ 'base' => NULL, 'refs' => [ 'JWTOptionsInput$SubjectKey' => 'Element of the JWT assertion to use for the user name.
', ], ], '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:
Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
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
The unit of a maintenance schedule duration. Valid value is HOUR
.
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.
The result of an UpdateDataSource
operation.
Container for the request parameters to the UpdateDomain
operation.
The results of an UpdateDomain
request. Contains the status of the domain being updated.
Container for request parameters to the UpdatePackage
operation.
Container for the response returned by the UpdatePackage
operation.
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.
Container for the response returned by UpgradeDomain
operation.
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:
In Progress
Succeeded
Succeeded with Issues
Failed
The current status of the upgrade. The status can take one of the following values:
In Progress
Succeeded
Succeeded with Issues
Failed
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:
PreUpgradeCheck
Snapshot
Upgrade
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
.
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
.
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.
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
.
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
).
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
.
The current state of the Availability Zone. Current options are Active
and StandBy
.
Active
- Data nodes in the Availability Zone are in use.
StandBy
- Data nodes in the Availability Zone are in a standby state.
NotAvailable
- Unable to retrieve information.
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.
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
.
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.
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.
Container for the parameters to the AddDataSource
operation.
The result of an AddDataSource
operation.
Container for the parameters to the AddTags
operation. Specifies the tags to attach to the domain.
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:
Allows references to indexes in an HTTP request body. Must be false
when configuring access to individual sub-resources. Default is true
.
Specifies the percentage of heap space allocated to field data. Default is unbounded.
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:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses
error.
"override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
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:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses
error.
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.
The advanced options configuration for the domain.
', ], ], 'AdvancedOptionsStatus' => [ 'base' => 'Status of the advanced options for the specified domain. The following options are available:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses
error.
"override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
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.
Container for the response returned by the AssociatePackage
operation.
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.
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.
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.
', 'JWTOptionsInput$Enabled' => 'True to enable JWT authentication and authorization for a domain.
', 'JWTOptionsOutput$Enabled' => 'True if JWT use is enabled.
', '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.
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
.
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.
DIRECT - Used for cross-cluster search or cross-cluster replication.
VPC_ENDPOINT - Used for remote reindex between Amazon OpenSearch Service VPC domains.
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.
The ConnectionProperties
for the newly created connection.
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.
Container for the parameters to the CreateOutboundConnection
operation.
The result of a CreateOutboundConnection
request. Contains details about the newly created cross-cluster connection.
Container for request parameters to the CreatePackage
operation.
Container for the response returned by the CreatePackage
operation.
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.
', ], ], 'DataSourceStatus' => [ 'base' => NULL, 'refs' => [ 'DataSourceDetails$Status' => 'The status of the data source.
', 'GetDataSourceResponse$Status' => 'The status of the data source.
', 'UpdateDataSourceRequest$Status' => 'The status of the data source update.
', ], ], '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.
The result of a GetDataSource
operation.
Container for the parameters to the DeleteDomain
operation.
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.
Container for the parameters to the DeleteInboundConnection
operation.
The results of a DeleteInboundConnection
operation. Contains details about the deleted inbound connection.
Container for the parameters to the DeleteOutboundConnection
operation.
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.
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:
Blue/Green - The update requires a blue/green deployment.
DynamicUpdate - No blue/green deployment required
Undetermined - The domain is in the middle of an update and can\'t predict the deployment type. Try again after the update is complete.
None - The request doesn\'t include any configuration changes.
Container for the parameters to the DescribeDomainAutoTunes
operation.
The result of a DescribeDomainAutoTunes
request.
Container for the parameters to the DescribeDomainChangeProgress
operation.
The result of a DescribeDomainChangeProgress
request. Contains progress information for the requested domain change.
Container for the parameters to the DescribeDomainConfig
operation.
Contains the configuration information of the requested domain.
', 'refs' => [], ], 'DescribeDomainHealthRequest' => [ 'base' => 'Container for the parameters to the DescribeDomainHealth
operation.
The result of a DescribeDomainHealth
request. Contains health information for the requested domain.
Container for the parameters to the DescribeDomainNodes
operation.
The result of a DescribeDomainNodes
request. Contains information about the nodes on the requested domain.
Container for the parameters to the DescribeDomain
operation.
Contains the status of the domain specified in the request.
', 'refs' => [], ], 'DescribeDomainsRequest' => [ 'base' => 'Container for the parameters to the DescribeDomains
operation.
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.
Contains a list of connections matching the filter criteria.
', 'refs' => [], ], 'DescribeInstanceTypeLimitsRequest' => [ 'base' => 'Container for the parameters to the DescribeInstanceTypeLimits
operation.
Container for the parameters received from the DescribeInstanceTypeLimits
operation.
Container for the parameters to the DescribeOutboundConnections
operation.
Contains a list of connections matching the filter criteria.
', 'refs' => [], ], 'DescribePackagesFilter' => [ 'base' => 'A filter to apply to the DescribePackage
response.
A list of DescribePackagesFilter
to filter the packages included in a DescribePackages
response.
Only returns packages that match the DescribePackagesFilterList
values.
Any field from PackageDetails
.
A non-empty list of values for the specified filter field.
', ], ], 'DescribePackagesRequest' => [ 'base' => 'Container for the request parameters to the DescribePackage
operation.
Container for the response returned by the DescribePackages
operation.
Container for the request parameters to a DescribeReservedInstanceOfferings
operation.
Container for results of a DescribeReservedInstanceOfferings
request.
Container for the request parameters to the DescribeReservedInstances
operation.
Container for results from DescribeReservedInstances
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.
Container for the response returned by an DissociatePackage
operation.
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.
Red
- At least one primary shard is not allocated to any node.
Yellow
- All primary shards are allocated to nodes, but some replicas aren’t.
Green
- All primary shards and their replicas are allocated to nodes.
NotAvailable
- Unable to retrieve cluster health.
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.
Contains nodes information list DomainNodesStatusList
with details about the all nodes on the requested domain.
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.
Processing
- The domain has updates in progress.
Active
- Requested changes have been processed and deployed to the domain.
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.
Whether or not the request was a dry run. If True
, the changes were not actually cancelled.
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.
The type of dry run to perform.
Basic
only returns the type of deployment (blue/green or dynamic) that the update will cause.
Verbose
runs an additional check to validate the changes you\'re making. For more information, see Validating a domain update.
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"}
.
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:
IPv4 IP addresses - \'vpc\',\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\'
Dual stack IP addresses - \'vpcv2\':\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws\'
The type of search engine that the domain is running.OpenSearch
for an OpenSearch engine, or Elasticsearch
for a legacy Elasticsearch OSS engine.
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.
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.
Container for the response returned by the GetCompatibleVersions
operation.
Container for the parameters to the GetDataSource
operation.
The result of a GetDataSource
operation.
Container for the parameters to the GetDomainMaintenanceStatus
operation.
The result of a GetDomainMaintenanceStatus
request that information about the requested action.
Container for the request parameters to the GetPackageVersionHistory
operation.
Container for response returned by GetPackageVersionHistory
operation.
Container for the request parameters to the GetUpgradeHistory
operation.
Container for the response returned by the GetUpgradeHistory
operation.
Container for the request parameters to the GetUpgradeStatus
operation.
Container for the response returned by the GetUpgradeStatus
operation.
The dual stack 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:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
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.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3
volume type.
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.
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.
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.
', ], ], 'JWTOptionsInput' => [ 'base' => 'The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.
', 'refs' => [ 'AdvancedSecurityOptionsInput$JWTOptions' => 'Container for information about the JWT configuration of the Amazon OpenSearch Service.
', ], ], 'JWTOptionsOutput' => [ 'base' => 'Describes the JWT options configured for the domain.
', 'refs' => [ 'AdvancedSecurityOptions$JWTOptions' => 'Container for information about the JWT configuration of the Amazon OpenSearch Service.
', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => 'The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
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' => ' MaximumNumberOfDataNodesSupported
- This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support.
MaximumNumberOfDataNodesWithoutMasterNode
- This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.
Name of storage limits that are applicable for the given storage type. If StorageType
is ebs
, the following options are available:
MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
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:
data - A data node.
master - A dedicated master node.
ultra_warm - An UltraWarm node.
Map that contains all applicable instance type limits.data
refers to data nodes.master
refers to dedicated master nodes.
Container for the parameters to the ListDataSources
operation.
The result of a ListDataSources
operation.
Container for the parameters to the ListDomainMaintenances
operation.
The result of a ListDomainMaintenances
request that contains information about the requested actions.
Container for the parameters to the ListDomainNames
operation.
The results of a ListDomainNames
operation. Contains the names of all domains owned by this account and their respective engine types.
Container for the request parameters to the ListDomainsForPackage
operation.
Container for the response parameters to the ListDomainsForPackage
operation.
Container for the request parameters to the ListPackagesForDomain
operation.
Container for the response parameters to the ListPackagesForDomain
operation.
Container for the parameters to the ListTags
operation.
The results of a ListTags
operation.
Container for the request parameters to the ListVersions
operation.
Container for the parameters for response received from the ListVersions
operation.
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.
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:
INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.
SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.
ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.
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
.
The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt
to TIMESTAMP
.
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.
Available - The domain has an elected master node.
UnAvailable - The master node hasn\'t yet been elected, and a quorum to elect a new master node hasn\'t been reached.
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.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
If your initial ListDomainMaintenances
operation returns a nextToken
, include the returned nextToken
in subsequent ListDomainMaintenances
operations, which returns results in the next page.
When nextToken
is returned, there are more results available. The value of nextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
.
The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable
.
The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable
.
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
.
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
.
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:
Processing - The requested change is still in progress.
Active - The requested change is processed and deployed to the domain.
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:
VALIDATING - The outbound connection request is being validated.
VALIDATION_FAILED - Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
PROVISIONING - Outbound connection request is in process.
ACTIVE - Outbound connection is active and ready to use.
REJECTING - Outbound connection rejection by remote domain owner is in progress.
REJECTED - Outbound connection request is rejected by remote domain owner.
DELETING - Outbound connection deletion is in progress.
DELETED - Outbound connection is deleted and can no longer be used.
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.
The internal ID of the package you want to delete. Use DescribePackages
to find this value.
Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain
to find this value.
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
.
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
.
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.
Additional information about plugin properties if the package is a ZIP-PLUGIN
package.
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:
PLAIN_TEXT
: Contain direct values such as "1", "True", or "c5.large.search".
STRINGIFIED_JSON
: Contain content in JSON format, such as {"Enabled":"True"}".
Container for request parameters to the PurchaseReservedInstanceOffering
operation.
Represents the output of a PurchaseReservedInstanceOffering
operation.
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.
The Amazon Web Services Region in which the domain is located.
', ], ], 'RejectInboundConnectionRequest' => [ 'base' => 'Container for the request parameters to the RejectInboundConnection
operation.
Represents the output of a RejectInboundConnection
operation.
Container for the request parameters to the RemoveTags
operation.
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.
>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
', ], ], 'RolesKey' => [ 'base' => NULL, 'refs' => [ 'JWTOptionsInput$RolesKey' => 'Element of the JWT assertion to use for roles.
', ], ], '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.
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.
NOW
- Immediately schedules the update to happen in the current hour if there\'s capacity available.
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime
.
OFF_PEAK_WINDOW
- Marks the update to be picked up during an upcoming off-peak window. There\'s no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
Default: NOW
if you don\'t specify a value for DesiredStartTime
, and TIMESTAMP
if you do.
When to schedule the action.
NOW
- Immediately schedules the update to happen in the current hour if there\'s capacity available.
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime
.
OFF_PEAK_WINDOW
- Marks the action to be picked up during an upcoming off-peak window. There\'s no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.
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
.
Whether the action was scheduled manually (CUSTOMER
, or by OpenSearch Service automatically (SYSTEM
).
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
.
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.
The status of SkipUnavailable
setting for the outbound connection.
ENABLED - The SkipUnavailable
setting is enabled for the connection.
DISABLED - The SkipUnavailable
setting is disabled for the connection.
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.
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.
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.
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.
The result of a StartDomainMaintenance
request that information about the requested action.
Container for the request parameters to the StartServiceSoftwareUpdate
operation.
Represents the output of a StartServiceSoftwareUpdate
operation. Contains the status of the update.
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.
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
.
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:
standard
gp2
gp3
io1
The storage sub-type, such as gp3
or io1
.
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:
Built-in storage available for the instance.
Elastic Block Storage (EBS) attached to the instance.
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.
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.
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.
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.
Element of the JWT assertion used by the cluster to verify JWT signatures.
', 'JWTOptionsOutput$SubjectKey' => 'The key used for matching the JWT subject attribute.
', 'JWTOptionsOutput$RolesKey' => 'The key used for matching the JWT roles attribute.
', 'JWTOptionsOutput$PublicKey' => 'The key used to verify the signature of incoming JWT requests.
', '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.
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.
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
.
Element of the SAML assertion to use for backend roles. Default is roles
.
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.
', ], ], 'SubjectKey' => [ 'base' => NULL, 'refs' => [ 'JWTOptionsInput$SubjectKey' => 'Element of the JWT assertion to use for the user name.
', ], ], '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:
Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
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
The unit of a maintenance schedule duration. Valid value is HOUR
.
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.
The result of an UpdateDataSource
operation.
Container for the request parameters to the UpdateDomain
operation.
The results of an UpdateDomain
request. Contains the status of the domain being updated.
Container for request parameters to the UpdatePackage
operation.
Container for the response returned by the UpdatePackage
operation.
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.
Container for the response returned by UpgradeDomain
operation.
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:
In Progress
Succeeded
Succeeded with Issues
Failed
The current status of the upgrade. The status can take one of the following values:
In Progress
Succeeded
Succeeded with Issues
Failed
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:
PreUpgradeCheck
Snapshot
Upgrade
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
.
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
.
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.
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
.
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
).
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
.
The current state of the Availability Zone. Current options are Active
and StandBy
.
Active
- Data nodes in the Availability Zone are in use.
StandBy
- Data nodes in the Availability Zone are in a standby state.
NotAvailable
- Unable to retrieve information.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or Partition
parameters.
A single filter for any other dimension in this dimension group.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
parameter.
A single filter for any other dimension in this dimension group.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or Partition
parameters.
A single filter for any other dimension in this dimension group.
The db.sql.db_id
filter isn't available for RDS for SQL Server DB instances.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
parameter.
A single filter for any other dimension in this dimension group.
The db.sql.db_id
filter isn't available for RDS for SQL Server DB instances.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide .
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .
Creates a new performance analysis report for a specific time period for the DB instance.
', 'DeletePerformanceAnalysisReport' => 'Deletes a performance analysis report.
', 'DescribeDimensionKeys' => 'For a specific time period, retrieve the top N
dimension keys for a metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails
retrieves the full text of the dimension db.sql.statement
associated with this ID. This operation is useful because GetResourceMetrics
and DescribeDimensionKeys
don\'t support retrieval of large SQL statement text.
Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING
, SUCCEEDED
, or FAILED
. The insights include the description
and recommendation
fields.
Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
', 'GetResourceMetrics' => 'Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
', 'ListAvailableResourceMetrics' => 'Retrieve metrics of the specified types that can be queried for a specified DB instance.
', 'ListPerformanceAnalysisReports' => 'Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
', 'ListTagsForResource' => 'Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
', 'TagResource' => 'Adds metadata tags to the Amazon RDS Performance Insights resource.
', 'UntagResource' => 'Deletes the metadata tags from the Amazon RDS Performance Insights resource.
', ], 'shapes' => [ 'AcceptLanguage' => [ 'base' => NULL, 'refs' => [ 'GetPerformanceAnalysisReportRequest$AcceptLanguage' => 'The text language in the report. The default language is EN_US
(English).
Additional metrics for the top N
dimension keys. If the specified dimension group in the GroupBy
parameter is db.sql_tokenized
, you can specify per-SQL metrics to get the values for the top N
SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }
.
A map that contains the value for each additional metric.
', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => 'Lists all the tags for the Amazon RDS Performance Insights resource. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', 'TagResourceRequest$ResourceARN' => 'The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', 'UntagResourceRequest$ResourceARN' => 'The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', ], ], 'AnalysisReport' => [ 'base' => 'Retrieves the summary of the performance analysis report created for a time period.
', 'refs' => [ 'GetPerformanceAnalysisReportResponse$AnalysisReport' => 'The summary of the performance analysis report created for a time period.
', ], ], 'AnalysisReportId' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$AnalysisReportId' => 'The name of the analysis report.
', 'CreatePerformanceAnalysisReportResponse$AnalysisReportId' => 'A unique identifier for the created analysis report.
', 'DeletePerformanceAnalysisReportRequest$AnalysisReportId' => 'The unique identifier of the analysis report for deletion.
', 'GetPerformanceAnalysisReportRequest$AnalysisReportId' => 'A unique identifier of the created analysis report. For example, report-12345678901234567
Retrieves the details of the performance analysis report.
', 'refs' => [ 'AnalysisReportSummaryList$member' => NULL, ], ], 'AnalysisReportSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPerformanceAnalysisReportsResponse$AnalysisReports' => 'List of reports including the report identifier, start and end time, creation time, and status.
', ], ], 'AnalysisStatus' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$Status' => 'The status of the created analysis report.
', 'AnalysisReportSummary$Status' => 'The status of the analysis report.
', ], ], 'AuthorizedActionsList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsRequest$AuthorizedActions' => 'The actions to discover the dimensions you are authorized to access. If you specify multiple actions, then the response will contain the dimensions common for all the actions.
When you don\'t specify this request parameter or provide an empty list, the response contains all the available dimensions for the target database engine whether or not you are authorized to access them.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ListPerformanceAnalysisReportsRequest$ListTags' => 'Specifies whether or not to include the list of tags in the response.
', ], ], 'ContextType' => [ 'base' => NULL, 'refs' => [ 'Insight$Context' => 'Indicates if the insight is causal or correlated insight.
', ], ], 'CreatePerformanceAnalysisReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePerformanceAnalysisReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'Data' => [ 'base' => 'List of data objects which provide details about source metrics. This field can be used to determine the PI metric to render for the insight. This data type also includes static values for the metrics for the Insight that were calculated and included in text and annotations on the DB load chart.
', 'refs' => [ 'DataList$member' => NULL, ], ], 'DataList' => [ 'base' => NULL, 'refs' => [ 'Insight$InsightData' => 'List of data objects containing metrics and references from the time range while generating the insight.
', 'Insight$BaselineData' => 'Metric names and values from the timeframe used as baseline to generate the insight.
', ], ], 'DataPoint' => [ 'base' => 'A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
', 'refs' => [ 'DataPointsList$member' => NULL, ], ], 'DataPointsList' => [ 'base' => NULL, 'refs' => [ 'MetricKeyDataPoints$DataPoints' => 'An array of timestamp-value pairs, representing measurements over a period of time.
', ], ], 'DeletePerformanceAnalysisReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePerformanceAnalysisReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDimensionKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDimensionKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ResponseResourceMetric$Description' => 'The description of the metric.
', ], ], 'DescriptiveMap' => [ 'base' => NULL, 'refs' => [ 'PerformanceInsightsMetric$Dimensions' => 'A dimension map that contains the dimensions for this partition.
', ], ], 'DescriptiveString' => [ 'base' => NULL, 'refs' => [ 'DescriptiveMap$key' => NULL, 'DescriptiveMap$value' => NULL, 'PerformanceInsightsMetric$Metric' => 'The Performance Insights metric.
', 'PerformanceInsightsMetric$DisplayName' => 'The Performance Insights metric name.
', ], ], 'DetailStatus' => [ 'base' => NULL, 'refs' => [ 'DimensionKeyDetail$Status' => 'The status of the dimension detail data. Possible values include the following:
AVAILABLE
- The dimension detail data is ready to be retrieved.
PROCESSING
- The dimension detail data isn\'t ready to be retrieved because more processing time is required. If the requested detail data has the status PROCESSING
, Performance Insights returns the truncated query.
UNAVAILABLE
- The dimension detail data could not be collected successfully.
The information about a dimension.
', 'refs' => [ 'DimensionDetailList$member' => NULL, ], ], 'DimensionDetailList' => [ 'base' => NULL, 'refs' => [ 'DimensionGroupDetail$Dimensions' => 'The dimensions within a dimension group.
', ], ], 'DimensionGroup' => [ 'base' => 'A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql
dimension group consists of the following dimensions:
db.sql.id
- The hash of a running SQL statement, generated by Performance Insights.
db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-
.
db.sql.statement
- The full text of the SQL statement that is running, for example, SELECT * FROM employees
.
db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
', 'DescribeDimensionKeysRequest$PartitionBy' => 'For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide the partition keys in the response.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
', ], ], 'DimensionGroupDetail' => [ 'base' => 'Information about dimensions within a dimension group.
', 'refs' => [ 'DimensionGroupDetailList$member' => NULL, ], ], 'DimensionGroupDetailList' => [ 'base' => NULL, 'refs' => [ 'MetricDimensionGroups$Groups' => 'The available dimension groups for a metric type.
', ], ], 'DimensionKeyDescription' => [ 'base' => 'An object that includes the requested dimension key values and aggregated metric values within a dimension group.
', 'refs' => [ 'DimensionKeyDescriptionList$member' => NULL, ], ], 'DimensionKeyDescriptionList' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysResponse$Keys' => 'The dimension keys that were requested.
', ], ], 'DimensionKeyDetail' => [ 'base' => 'An object that describes the details for a specified dimension.
', 'refs' => [ 'DimensionKeyDetailList$member' => NULL, ], ], 'DimensionKeyDetailList' => [ 'base' => NULL, 'refs' => [ 'GetDimensionKeyDetailsResponse$Dimensions' => 'The details for the requested dimensions.
', ], ], 'DimensionMap' => [ 'base' => NULL, 'refs' => [ 'DimensionKeyDescription$Dimensions' => 'A map of name-value pairs for the dimensions in the group.
', 'ResponsePartitionKey$Dimensions' => 'A dimension map that contains the dimensions for this partition.
', 'ResponseResourceMetricKey$Dimensions' => 'The valid dimensions for the metric.
', ], ], 'DimensionsMetricList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsRequest$Metrics' => 'The types of metrics for which to retrieve dimensions. Valid values include db.load
.
The actual value associated with a particular Timestamp
.
The aggregated metric value for the dimensions, over the requested time range.
', 'MetricValuesList$member' => NULL, 'PerformanceInsightsMetric$Value' => 'The value of the metric. For example, 9
for db.load.avg
.
The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
', 'refs' => [ 'FeatureMetadataMap$value' => NULL, ], ], 'FeatureMetadataMap' => [ 'base' => NULL, 'refs' => [ 'GetResourceMetadataResponse$Features' => 'The metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'FeatureMetadata$Status' => 'The status of the feature on the DB instance. Possible values include the following:
ENABLED
- The feature is enabled on the instance.
DISABLED
- The feature is disabled on the instance.
UNSUPPORTED
- The feature isn\'t supported on the instance.
ENABLED_PENDING_REBOOT
- The feature is enabled on the instance but requires a reboot to take effect.
DISABLED_PENDING_REBOOT
- The feature is disabled on the instance but requires a reboot to take effect.
UNKNOWN
- The feature status couldn\'t be determined.
The time you created the analysis report.
', 'AnalysisReport$StartTime' => 'The analysis start time in the report.
', 'AnalysisReport$EndTime' => 'The analysis end time in the report.
', 'AnalysisReportSummary$CreateTime' => 'The time you created the analysis report.
', 'AnalysisReportSummary$StartTime' => 'The start time of the analysis in the report.
', 'AnalysisReportSummary$EndTime' => 'The end time of the analysis in the report.
', 'CreatePerformanceAnalysisReportRequest$StartTime' => 'The start time defined for the analysis report.
', 'CreatePerformanceAnalysisReportRequest$EndTime' => 'The end time defined for the analysis report.
', 'DataPoint$Timestamp' => 'The time, in epoch format, associated with a particular Value
.
The date and time specifying the beginning of the requested time series data. You must specify a StartTime
within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime
are returned.
The value for EndTime
must be later than the value for StartTime
.
The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedEndTime
will be greater than or equal to the value of the user-specified Endtime
.
The date and time specifying the beginning of the requested time series query range. You can\'t specify a StartTime
that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime
.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime
.
The value for EndTime
must be later than the value for StartTime
.
The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedEndTime
will be greater than or equal to the value of the user-specified Endtime
.
The start time of the insight. For example, 2018-10-30T00:00:00Z
.
The end time of the insight. For example, 2018-10-30T00:00:00Z
.
The unique identifier of the analysis report.
', 'CreatePerformanceAnalysisReportRequest$Identifier' => 'An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
.
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ
.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
Retrieves the list of performance issues which are identified.
', 'refs' => [ 'InsightList$member' => NULL, ], ], 'InsightList' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$Insights' => 'The list of identified insights in the analysis report.
', 'Insight$SupportingInsights' => 'List of supporting insights that provide additional factors for the insight.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysRequest$PeriodInSeconds' => 'The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don\'t specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don\'t specify PeriodInSeconds
, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.
The request failed due to an unknown error.
', 'refs' => [], ], 'InvalidArgumentException' => [ 'base' => 'One of the arguments provided is invalid for this request.
', 'refs' => [], ], 'Limit' => [ 'base' => NULL, 'refs' => [ 'DimensionGroup$Limit' => 'The maximum number of items to fetch for this dimension group.
', ], ], 'ListAvailableResourceDimensionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceDimensionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPerformanceAnalysisReportsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPerformanceAnalysisReportsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MarkdownString' => [ 'base' => NULL, 'refs' => [ 'Insight$Description' => 'Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact
.
The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return. If the MaxRecords
value is less than the number of existing items, the response includes a pagination token.
The maximum number of items to return in the response. If more items exist than the specified MaxResults
value, a pagination token is included in the response so that the remaining results can be retrieved.
The available dimension information for a metric type.
', 'refs' => [ 'MetricDimensionsList$member' => NULL, ], ], 'MetricDimensionsList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsResponse$MetricDimensions' => 'The dimension information returned for requested metric types.
', ], ], 'MetricKeyDataPoints' => [ 'base' => 'A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.
', 'refs' => [ 'MetricKeyDataPointsList$member' => NULL, ], ], 'MetricKeyDataPointsList' => [ 'base' => NULL, 'refs' => [ 'GetResourceMetricsResponse$MetricList' => 'An array of metric results, where each array element contains all of the data points for a particular dimension.
', ], ], 'MetricQuery' => [ 'base' => 'A single query to be processed. You must provide the metric to query and append an aggregate function to the metric. For example, to find the average for the metric db.load
you must use db.load.avg
. Valid values for aggregate functions include .avg
, .min
, .max
, and .sum
. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy
), and return only those data points that match your criteria (Filter
).
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or Partition
parameters.
A single filter for any other dimension in this dimension group.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
parameter.
A single filter for any other dimension in this dimension group.
An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load
you must use db.load.avg
. Valid values for aggregate functions include .avg
, .min
, .max
, and .sum
.
The types of metrics to return in the response. Valid values in the array include the following:
os
(OS counter metrics) - All engines
db
(DB load metrics) - All engines except for Amazon DocumentDB
db.sql.stats
(per-SQL metrics) - All engines except for Amazon DocumentDB
db.sql_tokenized.stats
(per-SQL digest metrics) - All engines except for Amazon DocumentDB
If PartitionBy
was specified, PartitionKeys
contains the dimensions that were.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
A pagination token that indicates the response didn’t return all available records because MaxRecords
was specified in the previous request. To get the remaining records, specify NextToken
in a separate request with this value.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
A pagination token that indicates the response didn’t return all available records because MaxRecords
was specified in the previous request. To get the remaining records, specify NextToken
in a separate request with this value.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults
.
The user is not authorized to perform this request.
', 'refs' => [], ], 'PerformanceInsightsMetric' => [ 'base' => 'This data type helps to determine Performance Insights metric to render for the insight.
', 'refs' => [ 'Data$PerformanceInsightsMetric' => 'This field determines the Performance Insights metric to render for the insight. The name
field refers to a Performance Insights metric.
The returned timestamp which is the start or end time of the time periods. The default value is END_TIME
.
The list of recommendations for the insight.
', 'refs' => [ 'RecommendationList$member' => NULL, ], ], 'RecommendationList' => [ 'base' => NULL, 'refs' => [ 'Insight$Recommendations' => 'List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
.
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- The raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:
db.query
(Amazon DocumentDB only)
db.sql
(Amazon RDS and Aurora only)
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql
, the group ID is db.sql.id
. The following group ID values are valid:
db.sql.id
for dimension group db.sql
(Aurora and RDS only)
db.query.id
for dimension group db.query
(DocumentDB only)
A list of dimensions to retrieve the detail data for within the given dimension group. If you don\'t specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
db.sql
- Specify either the full dimension name db.sql.statement
or the short dimension name statement
(Aurora and RDS only).
db.query
- Specify either the full dimension name db.query.statement
or the short dimension name statement
(DocumentDB only).
If PartitionBy
was specified in a DescribeDimensionKeys
request, the dimensions are returned in an array. Each element in the array specifies one dimension.
If PartitionBy
was present in the request, PartitionKeys
contains the breakdown of dimension keys by the specified partitions.
An object that contains the full name, description, and unit of a metric.
', 'refs' => [ 'ResponseResourceMetricList$member' => NULL, ], ], 'ResponseResourceMetricKey' => [ 'base' => 'An object describing a Performance Insights metric and one or more dimensions for that metric.
', 'refs' => [ 'MetricKeyDataPoints$Key' => 'The dimensions to which the data points apply.
', ], ], 'ResponseResourceMetricList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceMetricsResponse$Metrics' => 'An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.
', ], ], 'SanitizedString' => [ 'base' => 'A generic string type that forbids characters that could expose our service (or services downstream) to security risks around injections.', 'refs' => [ 'AdditionalMetricsList$member' => NULL, 'DimensionGroup$Group' => 'The name of the dimension group. Valid values are as follows:
db
- The name of the database to which the client is connected. The following values are permitted:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Aurora MySQL
Amazon RDS MySQL
Amazon RDS MariaDB
Amazon DocumentDB
db.application
- The name of the application that is connected to the database. The following values are permitted:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Amazon DocumentDB
db.host
- The host name of the connected client (all engines).
db.query
- The query that is currently running (only Amazon DocumentDB).
db.query_tokenized
- The digest query (only Amazon DocumentDB).
db.session_type
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).
db.sql
- The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).
db.sql_tokenized
- The SQL digest (all engines except Amazon DocumentDB).
db.user
- The user logged in to the database (all engines except Amazon DocumentDB).
db.wait_event
- The event for which the database backend is waiting (all engines except Amazon DocumentDB).
db.wait_event_type
- The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).
db.wait_state
- The event for which the database backend is waiting (only Amazon DocumentDB).
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.
Valid values for elements in the Dimensions
array are:
db.application.name
- The name of the application that is connected to the database. Valid values are as follows:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Amazon DocumentDB
db.host.id
- The host ID of the connected client (all engines).
db.host.name
- The host name of the connected client (all engines).
db.name
- The name of the database to which the client is connected. Valid values are as follows:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Aurora MySQL
Amazon RDS MySQL
Amazon RDS MariaDB
Amazon DocumentDB
db.query.id
- The query ID generated by Performance Insights (only Amazon DocumentDB).
db.query.db_id
- The query ID generated by the database (only Amazon DocumentDB).
db.query.statement
- The text of the query that is being run (only Amazon DocumentDB).
db.query.tokenized_id
db.query.tokenized.id
- The query digest ID generated by Performance Insights (only Amazon DocumentDB).
db.query.tokenized.db_id
- The query digest ID generated by Performance Insights (only Amazon DocumentDB).
db.query.tokenized.statement
- The text of the query digest (only Amazon DocumentDB).
db.session_type.name
- The type of the current session (only Amazon DocumentDB).
db.sql.id
- The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).
db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-
(all engines except Amazon DocumentDB).
db.sql.statement
- The full text of the SQL statement that is running, as in SELECT * FROM employees
(all engines except Amazon DocumentDB)
db.sql.tokenized_id
db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id
is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.
db.sql_tokenized.db_id
- Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224
that Performance Insights generates if the native database ID isn\'t available (all engines except Amazon DocumentDB).
db.sql_tokenized.statement
- The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ?
(all engines except Amazon DocumentDB)
db.user.id
- The ID of the user logged in to the database (all engines except Amazon DocumentDB).
db.user.name
- The name of the user logged in to the database (all engines except Amazon DocumentDB).
db.wait_event.name
- The event for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_event.type
- The type of event for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_event_type.name
- The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_state.name
- The event for which the backend is waiting (only Amazon DocumentDB).
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS
.
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS
.
The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS
.
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS
.
The Amazon Web Services service for which Performance Insights returns metrics.
', 'GetResourceMetricsRequest$ServiceType' => 'The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights returns metrics.
', 'ListAvailableResourceMetricsRequest$ServiceType' => 'The Amazon Web Services service for which Performance Insights returns metrics.
', 'ListPerformanceAnalysisReportsRequest$ServiceType' => 'The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS
.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS
.
The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS
.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS
.
The severity of the insight. The values are: Low
, Medium
, or High
.
The name of the analysis report.
', 'DimensionDetail$Identifier' => 'The identifier of a dimension.
', 'DimensionGroupDetail$Group' => 'The name of the dimension group.
', 'DimensionKeyDetail$Value' => 'The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:
db.query.statement
(Amazon DocumentDB)
db.sql.statement
(Amazon RDS and Aurora)
The full name of the dimension. The full name includes the group name and key name. The following values are valid:
db.query.statement
(Amazon DocumentDB)
db.sql.statement
(Amazon RDS and Aurora)
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
The unique identifier for the insight. For example, insight-12345678901234567
.
The type of insight. For example, HighDBLoad
, HighCPU
, or DominatingSQLs
.
The metric type to which the dimension information belongs.
', 'Recommendation$RecommendationId' => 'The unique identifier for the recommendation.
', 'ResponseResourceMetric$Metric' => 'The full name of the metric.
', 'ResponseResourceMetric$Unit' => 'The unit of the metric.
', 'ResponseResourceMetricKey$Metric' => 'The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can\'t be prefixed with aws:
or rds:
. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$"
).
The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AnalysisReportSummary$Tags' => 'List of all the tags added to the analysis report.
', 'CreatePerformanceAnalysisReportRequest$Tags' => 'The metadata assigned to the analysis report consisting of a key-value pair.
', 'ListTagsForResourceResponse$Tags' => 'The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
', 'TagResourceRequest$Tags' => 'The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can\'t be prefixed with aws:
or rds:
. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$").
Indicates the text format in the report. The options are PLAIN_TEXT
or MARKDOWN
. The default value is plain text
.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide .
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .
Creates a new performance analysis report for a specific time period for the DB instance.
', 'DeletePerformanceAnalysisReport' => 'Deletes a performance analysis report.
', 'DescribeDimensionKeys' => 'For a specific time period, retrieve the top N
dimension keys for a metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails
retrieves the full text of the dimension db.sql.statement
associated with this ID. This operation is useful because GetResourceMetrics
and DescribeDimensionKeys
don\'t support retrieval of large SQL statement text.
Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING
, SUCCEEDED
, or FAILED
. The insights include the description
and recommendation
fields.
Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
', 'GetResourceMetrics' => 'Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
', 'ListAvailableResourceMetrics' => 'Retrieve metrics of the specified types that can be queried for a specified DB instance.
', 'ListPerformanceAnalysisReports' => 'Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
', 'ListTagsForResource' => 'Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
', 'TagResource' => 'Adds metadata tags to the Amazon RDS Performance Insights resource.
', 'UntagResource' => 'Deletes the metadata tags from the Amazon RDS Performance Insights resource.
', ], 'shapes' => [ 'AcceptLanguage' => [ 'base' => NULL, 'refs' => [ 'GetPerformanceAnalysisReportRequest$AcceptLanguage' => 'The text language in the report. The default language is EN_US
(English).
Additional metrics for the top N
dimension keys. If the specified dimension group in the GroupBy
parameter is db.sql_tokenized
, you can specify per-SQL metrics to get the values for the top N
SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }
.
A map that contains the value for each additional metric.
', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => 'Lists all the tags for the Amazon RDS Performance Insights resource. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', 'TagResourceRequest$ResourceARN' => 'The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', 'UntagResourceRequest$ResourceARN' => 'The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
', ], ], 'AnalysisReport' => [ 'base' => 'Retrieves the summary of the performance analysis report created for a time period.
', 'refs' => [ 'GetPerformanceAnalysisReportResponse$AnalysisReport' => 'The summary of the performance analysis report created for a time period.
', ], ], 'AnalysisReportId' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$AnalysisReportId' => 'The name of the analysis report.
', 'CreatePerformanceAnalysisReportResponse$AnalysisReportId' => 'A unique identifier for the created analysis report.
', 'DeletePerformanceAnalysisReportRequest$AnalysisReportId' => 'The unique identifier of the analysis report for deletion.
', 'GetPerformanceAnalysisReportRequest$AnalysisReportId' => 'A unique identifier of the created analysis report. For example, report-12345678901234567
Retrieves the details of the performance analysis report.
', 'refs' => [ 'AnalysisReportSummaryList$member' => NULL, ], ], 'AnalysisReportSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPerformanceAnalysisReportsResponse$AnalysisReports' => 'List of reports including the report identifier, start and end time, creation time, and status.
', ], ], 'AnalysisStatus' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$Status' => 'The status of the created analysis report.
', 'AnalysisReportSummary$Status' => 'The status of the analysis report.
', ], ], 'AuthorizedActionsList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsRequest$AuthorizedActions' => 'The actions to discover the dimensions you are authorized to access. If you specify multiple actions, then the response will contain the dimensions common for all the actions.
When you don\'t specify this request parameter or provide an empty list, the response contains all the available dimensions for the target database engine whether or not you are authorized to access them.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ListPerformanceAnalysisReportsRequest$ListTags' => 'Specifies whether or not to include the list of tags in the response.
', ], ], 'ContextType' => [ 'base' => NULL, 'refs' => [ 'Insight$Context' => 'Indicates if the insight is causal or correlated insight.
', ], ], 'CreatePerformanceAnalysisReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePerformanceAnalysisReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'Data' => [ 'base' => 'List of data objects which provide details about source metrics. This field can be used to determine the PI metric to render for the insight. This data type also includes static values for the metrics for the Insight that were calculated and included in text and annotations on the DB load chart.
', 'refs' => [ 'DataList$member' => NULL, ], ], 'DataList' => [ 'base' => NULL, 'refs' => [ 'Insight$InsightData' => 'List of data objects containing metrics and references from the time range while generating the insight.
', 'Insight$BaselineData' => 'Metric names and values from the timeframe used as baseline to generate the insight.
', ], ], 'DataPoint' => [ 'base' => 'A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
', 'refs' => [ 'DataPointsList$member' => NULL, ], ], 'DataPointsList' => [ 'base' => NULL, 'refs' => [ 'MetricKeyDataPoints$DataPoints' => 'An array of timestamp-value pairs, representing measurements over a period of time.
', ], ], 'DeletePerformanceAnalysisReportRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePerformanceAnalysisReportResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDimensionKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDimensionKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ResponseResourceMetric$Description' => 'The description of the metric.
', ], ], 'DescriptiveMap' => [ 'base' => NULL, 'refs' => [ 'PerformanceInsightsMetric$Dimensions' => 'A dimension map that contains the dimensions for this partition.
', ], ], 'DescriptiveString' => [ 'base' => NULL, 'refs' => [ 'DescriptiveMap$key' => NULL, 'DescriptiveMap$value' => NULL, 'PerformanceInsightsMetric$Metric' => 'The Performance Insights metric.
', 'PerformanceInsightsMetric$DisplayName' => 'The Performance Insights metric name.
', ], ], 'DetailStatus' => [ 'base' => NULL, 'refs' => [ 'DimensionKeyDetail$Status' => 'The status of the dimension detail data. Possible values include the following:
AVAILABLE
- The dimension detail data is ready to be retrieved.
PROCESSING
- The dimension detail data isn\'t ready to be retrieved because more processing time is required. If the requested detail data has the status PROCESSING
, Performance Insights returns the truncated query.
UNAVAILABLE
- The dimension detail data could not be collected successfully.
The information about a dimension.
', 'refs' => [ 'DimensionDetailList$member' => NULL, ], ], 'DimensionDetailList' => [ 'base' => NULL, 'refs' => [ 'DimensionGroupDetail$Dimensions' => 'The dimensions within a dimension group.
', ], ], 'DimensionGroup' => [ 'base' => 'A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql
dimension group consists of the following dimensions:
db.sql.id
- The hash of a running SQL statement, generated by Performance Insights.
db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-
.
db.sql.statement
- The full text of the SQL statement that is running, for example, SELECT * FROM employees
.
db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
', 'DescribeDimensionKeysRequest$PartitionBy' => 'For each dimension specified in GroupBy
, specify a secondary dimension to further subdivide the partition keys in the response.
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
', ], ], 'DimensionGroupDetail' => [ 'base' => 'Information about dimensions within a dimension group.
', 'refs' => [ 'DimensionGroupDetailList$member' => NULL, ], ], 'DimensionGroupDetailList' => [ 'base' => NULL, 'refs' => [ 'MetricDimensionGroups$Groups' => 'The available dimension groups for a metric type.
', ], ], 'DimensionKeyDescription' => [ 'base' => 'An object that includes the requested dimension key values and aggregated metric values within a dimension group.
', 'refs' => [ 'DimensionKeyDescriptionList$member' => NULL, ], ], 'DimensionKeyDescriptionList' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysResponse$Keys' => 'The dimension keys that were requested.
', ], ], 'DimensionKeyDetail' => [ 'base' => 'An object that describes the details for a specified dimension.
', 'refs' => [ 'DimensionKeyDetailList$member' => NULL, ], ], 'DimensionKeyDetailList' => [ 'base' => NULL, 'refs' => [ 'GetDimensionKeyDetailsResponse$Dimensions' => 'The details for the requested dimensions.
', ], ], 'DimensionMap' => [ 'base' => NULL, 'refs' => [ 'DimensionKeyDescription$Dimensions' => 'A map of name-value pairs for the dimensions in the group.
', 'ResponsePartitionKey$Dimensions' => 'A dimension map that contains the dimensions for this partition.
', 'ResponseResourceMetricKey$Dimensions' => 'The valid dimensions for the metric.
', ], ], 'DimensionsMetricList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsRequest$Metrics' => 'The types of metrics for which to retrieve dimensions. Valid values include db.load
.
The actual value associated with a particular Timestamp
.
The aggregated metric value for the dimensions, over the requested time range.
', 'MetricValuesList$member' => NULL, 'PerformanceInsightsMetric$Value' => 'The value of the metric. For example, 9
for db.load.avg
.
The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
', 'refs' => [ 'FeatureMetadataMap$value' => NULL, ], ], 'FeatureMetadataMap' => [ 'base' => NULL, 'refs' => [ 'GetResourceMetadataResponse$Features' => 'The metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'FeatureMetadata$Status' => 'The status of the feature on the DB instance. Possible values include the following:
ENABLED
- The feature is enabled on the instance.
DISABLED
- The feature is disabled on the instance.
UNSUPPORTED
- The feature isn\'t supported on the instance.
ENABLED_PENDING_REBOOT
- The feature is enabled on the instance but requires a reboot to take effect.
DISABLED_PENDING_REBOOT
- The feature is disabled on the instance but requires a reboot to take effect.
UNKNOWN
- The feature status couldn\'t be determined.
The time you created the analysis report.
', 'AnalysisReport$StartTime' => 'The analysis start time in the report.
', 'AnalysisReport$EndTime' => 'The analysis end time in the report.
', 'AnalysisReportSummary$CreateTime' => 'The time you created the analysis report.
', 'AnalysisReportSummary$StartTime' => 'The start time of the analysis in the report.
', 'AnalysisReportSummary$EndTime' => 'The end time of the analysis in the report.
', 'CreatePerformanceAnalysisReportRequest$StartTime' => 'The start time defined for the analysis report.
', 'CreatePerformanceAnalysisReportRequest$EndTime' => 'The end time defined for the analysis report.
', 'DataPoint$Timestamp' => 'The time, in epoch format, associated with a particular Value
.
The date and time specifying the beginning of the requested time series data. You must specify a StartTime
within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime
are returned.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime
are returned.
The value for EndTime
must be later than the value for StartTime
.
The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedEndTime
will be greater than or equal to the value of the user-specified Endtime
.
The date and time specifying the beginning of the requested time series query range. You can\'t specify a StartTime
that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime
.
The value for StartTime
must be earlier than the value for EndTime
.
The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime
.
The value for EndTime
must be later than the value for StartTime
.
The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedStartTime
will be less than or equal to the value of the user-specified StartTime
.
The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds
). AlignedEndTime
will be greater than or equal to the value of the user-specified Endtime
.
The start time of the insight. For example, 2018-10-30T00:00:00Z
.
The end time of the insight. For example, 2018-10-30T00:00:00Z
.
The unique identifier of the analysis report.
', 'CreatePerformanceAnalysisReportRequest$Identifier' => 'An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its DbiResourceId
value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
.
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ
.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
Retrieves the list of performance issues which are identified.
', 'refs' => [ 'InsightList$member' => NULL, ], ], 'InsightList' => [ 'base' => NULL, 'refs' => [ 'AnalysisReport$Insights' => 'The list of identified insights in the analysis report.
', 'Insight$SupportingInsights' => 'List of supporting insights that provide additional factors for the insight.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'DescribeDimensionKeysRequest$PeriodInSeconds' => 'The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don\'t specify PeriodInSeconds
, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:
1
(one second)
60
(one minute)
300
(five minutes)
3600
(one hour)
86400
(twenty-four hours)
If you don\'t specify PeriodInSeconds
, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.
The request failed due to an unknown error.
', 'refs' => [], ], 'InvalidArgumentException' => [ 'base' => 'One of the arguments provided is invalid for this request.
', 'refs' => [], ], 'Limit' => [ 'base' => NULL, 'refs' => [ 'DimensionGroup$Limit' => 'The maximum number of items to fetch for this dimension group.
', ], ], 'ListAvailableResourceDimensionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceDimensionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableResourceMetricsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPerformanceAnalysisReportsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPerformanceAnalysisReportsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MarkdownString' => [ 'base' => NULL, 'refs' => [ 'Insight$Description' => 'Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact
.
The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxRecords
value, a pagination token is included in the response so that the remaining results can be retrieved.
The maximum number of items to return. If the MaxRecords
value is less than the number of existing items, the response includes a pagination token.
The maximum number of items to return in the response. If more items exist than the specified MaxResults
value, a pagination token is included in the response so that the remaining results can be retrieved.
The available dimension information for a metric type.
', 'refs' => [ 'MetricDimensionsList$member' => NULL, ], ], 'MetricDimensionsList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceDimensionsResponse$MetricDimensions' => 'The dimension information returned for requested metric types.
', ], ], 'MetricKeyDataPoints' => [ 'base' => 'A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.
', 'refs' => [ 'MetricKeyDataPointsList$member' => NULL, ], ], 'MetricKeyDataPointsList' => [ 'base' => NULL, 'refs' => [ 'GetResourceMetricsResponse$MetricList' => 'An array of metric results, where each array element contains all of the data points for a particular dimension.
', ], ], 'MetricQuery' => [ 'base' => 'A single query to be processed. You must provide the metric to query and append an aggregate function to the metric. For example, to find the average for the metric db.load
you must use db.load.avg
. Valid values for aggregate functions include .avg
, .min
, .max
, and .sum
. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy
), and return only those data points that match your criteria (Filter
).
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
or Partition
parameters.
A single filter for any other dimension in this dimension group.
The db.sql.db_id
filter isn\'t available for RDS for SQL Server DB instances.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy
parameter.
A single filter for any other dimension in this dimension group.
The db.sql.db_id
filter isn\'t available for RDS for SQL Server DB instances.
An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load
you must use db.load.avg
. Valid values for aggregate functions include .avg
, .min
, .max
, and .sum
.
The types of metrics to return in the response. Valid values in the array include the following:
os
(OS counter metrics) - All engines
db
(DB load metrics) - All engines except for Amazon DocumentDB
db.sql.stats
(per-SQL metrics) - All engines except for Amazon DocumentDB
db.sql_tokenized.stats
(per-SQL digest metrics) - All engines except for Amazon DocumentDB
If PartitionBy
was specified, PartitionKeys
contains the dimensions that were.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
A pagination token that indicates the response didn’t return all available records because MaxRecords
was specified in the previous request. To get the remaining records, specify NextToken
in a separate request with this value.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords
.
A pagination token that indicates the response didn’t return all available records because MaxRecords
was specified in the previous request. To get the remaining records, specify NextToken
in a separate request with this value.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults
.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults
.
The user is not authorized to perform this request.
', 'refs' => [], ], 'PerformanceInsightsMetric' => [ 'base' => 'This data type helps to determine Performance Insights metric to render for the insight.
', 'refs' => [ 'Data$PerformanceInsightsMetric' => 'This field determines the Performance Insights metric to render for the insight. The name
field refers to a Performance Insights metric.
The returned timestamp which is the start or end time of the time periods. The default value is END_TIME
.
The list of recommendations for the insight.
', 'refs' => [ 'RecommendationList$member' => NULL, ], ], 'RecommendationList' => [ 'base' => NULL, 'refs' => [ 'Insight$Recommendations' => 'List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
.
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- The raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:
db.query
(Amazon DocumentDB only)
db.sql
(Amazon RDS and Aurora only)
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql
, the group ID is db.sql.id
. The following group ID values are valid:
db.sql.id
for dimension group db.sql
(Aurora and RDS only)
db.query.id
for dimension group db.query
(DocumentDB only)
A list of dimensions to retrieve the detail data for within the given dimension group. If you don\'t specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
db.sql
- Specify either the full dimension name db.sql.statement
or the short dimension name statement
(Aurora and RDS only).
db.query
- Specify either the full dimension name db.query.statement
or the short dimension name statement
(DocumentDB only).
If PartitionBy
was specified in a DescribeDimensionKeys
request, the dimensions are returned in an array. Each element in the array specifies one dimension.
If PartitionBy
was present in the request, PartitionKeys
contains the breakdown of dimension keys by the specified partitions.
An object that contains the full name, description, and unit of a metric.
', 'refs' => [ 'ResponseResourceMetricList$member' => NULL, ], ], 'ResponseResourceMetricKey' => [ 'base' => 'An object describing a Performance Insights metric and one or more dimensions for that metric.
', 'refs' => [ 'MetricKeyDataPoints$Key' => 'The dimensions to which the data points apply.
', ], ], 'ResponseResourceMetricList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableResourceMetricsResponse$Metrics' => 'An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.
', ], ], 'SanitizedString' => [ 'base' => 'A generic string type that forbids characters that could expose our service (or services downstream) to security risks around injections.', 'refs' => [ 'AdditionalMetricsList$member' => NULL, 'DimensionGroup$Group' => 'The name of the dimension group. Valid values are as follows:
db
- The name of the database to which the client is connected. The following values are permitted:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Aurora MySQL
Amazon RDS MySQL
Amazon RDS MariaDB
Amazon DocumentDB
db.application
- The name of the application that is connected to the database. The following values are permitted:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Amazon DocumentDB
db.host
- The host name of the connected client (all engines).
db.query
- The query that is currently running (only Amazon DocumentDB).
db.query_tokenized
- The digest query (only Amazon DocumentDB).
db.session_type
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).
db.sql
- The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).
db.sql_tokenized
- The SQL digest (all engines except Amazon DocumentDB).
db.user
- The user logged in to the database (all engines except Amazon DocumentDB).
db.wait_event
- The event for which the database backend is waiting (all engines except Amazon DocumentDB).
db.wait_event_type
- The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).
db.wait_state
- The event for which the database backend is waiting (only Amazon DocumentDB).
The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.
Valid values for elements in the Dimensions
array are:
db.application.name
- The name of the application that is connected to the database. Valid values are as follows:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Amazon DocumentDB
db.host.id
- The host ID of the connected client (all engines).
db.host.name
- The host name of the connected client (all engines).
db.name
- The name of the database to which the client is connected. Valid values are as follows:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Aurora MySQL
Amazon RDS MySQL
Amazon RDS MariaDB
Amazon DocumentDB
db.query.id
- The query ID generated by Performance Insights (only Amazon DocumentDB).
db.query.db_id
- The query ID generated by the database (only Amazon DocumentDB).
db.query.statement
- The text of the query that is being run (only Amazon DocumentDB).
db.query.tokenized_id
db.query.tokenized.id
- The query digest ID generated by Performance Insights (only Amazon DocumentDB).
db.query.tokenized.db_id
- The query digest ID generated by Performance Insights (only Amazon DocumentDB).
db.query.tokenized.statement
- The text of the query digest (only Amazon DocumentDB).
db.session_type.name
- The type of the current session (only Amazon DocumentDB).
db.sql.id
- The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).
db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-
(all engines except Amazon DocumentDB).
db.sql.statement
- The full text of the SQL statement that is running, as in SELECT * FROM employees
(all engines except Amazon DocumentDB)
db.sql.tokenized_id
db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id
is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.
db.sql_tokenized.db_id
- Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224
that Performance Insights generates if the native database ID isn\'t available (all engines except Amazon DocumentDB).
db.sql_tokenized.statement
- The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ?
(all engines except Amazon DocumentDB)
db.user.id
- The ID of the user logged in to the database (all engines except Amazon DocumentDB).
db.user.name
- The name of the user logged in to the database (all engines except Amazon DocumentDB).
db.wait_event.name
- The event for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_event.type
- The type of event for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_event_type.name
- The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_state.name
- The event for which the backend is waiting (only Amazon DocumentDB).
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS
.
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS
.
The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS
.
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS
.
The Amazon Web Services service for which Performance Insights returns metrics.
', 'GetResourceMetricsRequest$ServiceType' => 'The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
RDS
DOCDB
The Amazon Web Services service for which Performance Insights returns metrics.
', 'ListAvailableResourceMetricsRequest$ServiceType' => 'The Amazon Web Services service for which Performance Insights returns metrics.
', 'ListPerformanceAnalysisReportsRequest$ServiceType' => 'The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS
.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS
.
The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS
.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS
.
The severity of the insight. The values are: Low
, Medium
, or High
.
The name of the analysis report.
', 'DimensionDetail$Identifier' => 'The identifier of a dimension.
', 'DimensionGroupDetail$Group' => 'The name of the dimension group.
', 'DimensionKeyDetail$Value' => 'The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:
db.query.statement
(Amazon DocumentDB)
db.sql.statement
(Amazon RDS and Aurora)
The full name of the dimension. The full name includes the group name and key name. The following values are valid:
db.query.statement
(Amazon DocumentDB)
db.sql.statement
(Amazon RDS and Aurora)
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances
, the identifier is returned as DbiResourceId
.
The unique identifier for the insight. For example, insight-12345678901234567
.
The type of insight. For example, HighDBLoad
, HighCPU
, or DominatingSQLs
.
The metric type to which the dimension information belongs.
', 'Recommendation$RecommendationId' => 'The unique identifier for the recommendation.
', 'ResponseResourceMetric$Metric' => 'The full name of the metric.
', 'ResponseResourceMetric$Unit' => 'The unit of the metric.
', 'ResponseResourceMetricKey$Metric' => 'The name of a Performance Insights metric to be measured.
Valid values for Metric
are:
db.load.avg
- A scaled representation of the number of active sessions for the database engine.
db.sampledload.avg
- The raw number of active sessions for the database engine.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
and db.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
showing the scaled values, db.sampledload.avg
showing the raw values, and db.sampledload.avg
less than db.load.avg
. For most use cases, you can query db.load.avg
only.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can\'t be prefixed with aws:
or rds:
. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$"
).
The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AnalysisReportSummary$Tags' => 'List of all the tags added to the analysis report.
', 'CreatePerformanceAnalysisReportRequest$Tags' => 'The metadata assigned to the analysis report consisting of a key-value pair.
', 'ListTagsForResourceResponse$Tags' => 'The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
', 'TagResourceRequest$Tags' => 'The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can\'t be prefixed with aws:
or rds:
. The string can only contain only the set of Unicode letters, digits, white-space, \'_\', \'.\', \':\', \'/\', \'=\', \'+\', \'-\', \'@\' (Java regex: "^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$").
Indicates the text format in the report. The options are PLAIN_TEXT
or MARKDOWN
. The default value is plain text
.
Describes the snapshots for the specified WorkSpace.
", "DescribeWorkspaces": "Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
", "DescribeWorkspacesConnectionStatus": "Describes the connection status of the specified WorkSpaces.
", - "DescribeWorkspacesPoolSessions": "Retrieves a list that describes the streaming sessions for a specified WorkSpaces pool.
", - "DescribeWorkspacesPools": "Describes the specified WorkSpaces pool.
", + "DescribeWorkspacesPoolSessions": "Retrieves a list that describes the streaming sessions for a specified pool.
", + "DescribeWorkspacesPools": "Describes the specified WorkSpaces Pools.
", "DisassociateConnectionAlias": "Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
Disassociates the specified IP access control group from the specified directory.
", "DisassociateWorkspaceApplication": "Disassociates the specified application from a WorkSpace.
", @@ -78,18 +78,18 @@ "RestoreWorkspace": "Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE
, ERROR
, UNHEALTHY
, or STOPPED
.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
", "RevokeIpRules": "Removes one or more rules from the specified IP access control group.
", "StartWorkspaces": "Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop
and a state of STOPPED
.
Starts the specified WorkSpaces pool.
You cannot start a WorkSpace pool unless it has a running mode of AutoStop
and a state of STOPPED
.
Starts the specified pool.
You cannot start a pool unless it has a running mode of AutoStop
and a state of STOPPED
.
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
Stops the specifiedWorkSpaces pool.
You cannot stop a WorkSpace pool unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
Stops the specified pool.
You cannot stop a WorkSpace pool unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED
.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED
state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Terminates the specified WorkSpaces pool.
", - "TerminateWorkspacesPoolSession": "Terminates the WorkSpaces pool session.
", + "TerminateWorkspacesPool": "Terminates the specified pool.
", + "TerminateWorkspacesPoolSession": "Terminates the pool session.
", "UpdateConnectClientAddIn": "Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
", "UpdateConnectionAliasPermission": "Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Replaces the current rules of the specified IP access control group with the specified rules.
", "UpdateWorkspaceBundle": "Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.
Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.
Updates the specified WorkSpaces pool.
" + "UpdateWorkspacesPool": "Updates the specified pool.
" }, "shapes": { "ARN": { @@ -98,7 +98,7 @@ "DefaultWorkspaceCreationProperties$InstanceIamRoleArn": "Indicates the IAM role ARN of the instance.
", "WorkspaceCreationProperties$InstanceIamRoleArn": "Indicates the IAM role ARN of the instance.
", "WorkspaceDirectory$IamRoleId": "The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
", - "WorkspacesPool$PoolArn": "The Amazon Resource Name (ARN) for the WorkSpaces pool.
" + "WorkspacesPool$PoolArn": "The Amazon Resource Name (ARN) for the pool.
" } }, "AcceptAccountLinkInvitationRequest": { @@ -181,7 +181,7 @@ "ActualUserSessions": { "base": null, "refs": { - "CapacityStatus$ActualUserSessions": "The total number of session slots that are available for WorkSpaces pools.
" + "CapacityStatus$ActualUserSessions": "The total number of session slots that are available for a pool of WorkSpaces.
" } }, "AddInName": { @@ -212,7 +212,7 @@ "ConnectClientAddIn$AddInId": "The client add-in identifier.
", "CreateConnectClientAddInResult$AddInId": "The client add-in identifier.
", "DeleteConnectClientAddInRequest$AddInId": "The identifier of the client add-in to delete.
", - "TerminateWorkspacesPoolSessionRequest$SessionId": "The identifier of the WorkSpaces pool session.
", + "TerminateWorkspacesPoolSessionRequest$SessionId": "The identifier of the pool session.
", "UpdateConnectClientAddInRequest$AddInId": "The identifier of the client add-in to update.
", "WorkspacesPoolSession$SessionId": "The identifier of the session.
" } @@ -260,14 +260,14 @@ } }, "ApplicationSettingsRequest": { - "base": "The persistent application settings for users of a WorkSpaces pool.
", + "base": "The persistent application settings for WorkSpaces Pools users.
", "refs": { - "CreateWorkspacesPoolRequest$ApplicationSettings": "Indicates the application settings of the WorkSpaces pool.
", + "CreateWorkspacesPoolRequest$ApplicationSettings": "Indicates the application settings of the pool.
", "UpdateWorkspacesPoolRequest$ApplicationSettings": "The persistent application settings for users in the pool.
" } }, "ApplicationSettingsResponse": { - "base": "Describes the persistent application settings for users of a WorkSpaces pool.
", + "base": "Describes the persistent application settings for WorkSpaces Pools users.
", "refs": { "WorkspacesPool$ApplicationSettings": "The persistent application settings for users of the pool.
" } @@ -342,7 +342,7 @@ "AuthenticationType": { "base": null, "refs": { - "WorkspacesPoolSession$AuthenticationType": "The authentication method. The user is authenticated using a WorkSpaces pool URL (API) or SAML 2.0 federation (SAML).
" + "WorkspacesPoolSession$AuthenticationType": "The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).
" } }, "AuthorizeIpRulesRequest": { @@ -418,7 +418,7 @@ "refs": { "BundleIdList$member": null, "BundleResourceAssociation$BundleId": "The identifier of the bundle.
", - "CreateWorkspacesPoolRequest$BundleId": "The identifier of the bundle for the WorkSpaces pool.
", + "CreateWorkspacesPoolRequest$BundleId": "The identifier of the bundle for the pool.
", "DeleteWorkspaceBundleRequest$BundleId": "The identifier of the bundle.
", "DescribeBundleAssociationsRequest$BundleId": "The identifier of the bundle.
", "DescribeWorkspacesRequest$BundleId": "The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
", @@ -469,14 +469,14 @@ } }, "Capacity": { - "base": "Describes the user capacity for a WorkSpaces pool.
", + "base": "Describes the user capacity for a pool of WorkSpaces.
", "refs": { - "CreateWorkspacesPoolRequest$Capacity": "The user capacity of the WorkSpaces pool.
", - "UpdateWorkspacesPoolRequest$Capacity": "The desired capacity for the WorkSpaces pool.
" + "CreateWorkspacesPoolRequest$Capacity": "The user capacity of the pool.
", + "UpdateWorkspacesPoolRequest$Capacity": "The desired capacity for the pool.
" } }, "CapacityStatus": { - "base": "Describes the capacity status for a WorkSpaces pool
", + "base": "Describes the capacity status for a pool of WorkSpaces.
", "refs": { "WorkspacesPool$CapacityStatus": "The capacity status for the pool
" } @@ -1265,7 +1265,7 @@ } }, "DescribeWorkspacesPoolsFilter": { - "base": "Describes the filter conditions for the WorkSpaces pool to return.
", + "base": "Describes the filter conditions for WorkSpaces Pools to return.
", "refs": { "DescribeWorkspacesPoolsFilters$member": null } @@ -1279,7 +1279,7 @@ "DescribeWorkspacesPoolsFilterOperator": { "base": null, "refs": { - "DescribeWorkspacesPoolsFilter$Operator": "The operator values for filtering WorkSpaces pools.
" + "DescribeWorkspacesPoolsFilter$Operator": "The operator values for filtering WorkSpaces Pools.
" } }, "DescribeWorkspacesPoolsFilterValue": { @@ -1291,13 +1291,13 @@ "DescribeWorkspacesPoolsFilterValues": { "base": null, "refs": { - "DescribeWorkspacesPoolsFilter$Values": "The values for filtering WorkSpaces pools.
" + "DescribeWorkspacesPoolsFilter$Values": "The values for filtering WorkSpaces Pools.
" } }, "DescribeWorkspacesPoolsFilters": { "base": null, "refs": { - "DescribeWorkspacesPoolsRequest$Filters": "The filter conditions for the WorkSpaces pool to return.
" + "DescribeWorkspacesPoolsRequest$Filters": "The filter conditions for the WorkSpaces Pool to return.
" } }, "DescribeWorkspacesPoolsRequest": { @@ -1347,7 +1347,7 @@ "AssociateIpGroupsRequest$DirectoryId": "The identifier of the directory.
", "ConnectClientAddIn$ResourceId": "The directory identifier for which the client add-in is configured.
", "CreateConnectClientAddInRequest$ResourceId": "The directory identifier for which to configure the client add-in.
", - "CreateWorkspacesPoolRequest$DirectoryId": "The identifier of the directory for the WorkSpaces pool.
", + "CreateWorkspacesPoolRequest$DirectoryId": "The identifier of the directory for the pool.
", "DeleteClientBrandingRequest$ResourceId": "The directory identifier of the WorkSpace for which you want to delete client branding.
", "DeleteConnectClientAddInRequest$ResourceId": "The directory identifier for which the client add-in is configured.
", "DeregisterWorkspaceDirectoryRequest$DirectoryId": "The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
", @@ -2004,7 +2004,7 @@ } }, "NetworkAccessConfiguration": { - "base": "Describes the network details of a WorkSpaces pool.
", + "base": "Describes the network details of a WorkSpaces Pool.
", "refs": { "WorkspacesPoolSession$NetworkAccessConfiguration": "Describes the network details of the pool.
" } @@ -2589,7 +2589,7 @@ "CreateUpdatedWorkspaceImageRequest$Tags": "The tags that you want to add to the new updated WorkSpace image.
To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags
.
The tags associated with the bundle.
To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags
.
The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags
.
The tags for the WorkSpaces pool.
", + "CreateWorkspacesPoolRequest$Tags": "The tags for the pool.
", "DescribeTagsResult$TagList": "The tags.
", "ImportWorkspaceImageRequest$Tags": "The tags. Each WorkSpaces resource can have a maximum of 50 tags.
", "RegisterWorkspaceDirectoryRequest$Tags": "The tags associated with the directory.
", @@ -2659,10 +2659,10 @@ } }, "TimeoutSettings": { - "base": "Describes the timeout settings for a WorkSpaces pool.
", + "base": "Describes the timeout settings for a pool of WorkSpaces.
", "refs": { - "CreateWorkspacesPoolRequest$TimeoutSettings": "Indicates the timeout settings of the WorkSpaces pool.
", - "UpdateWorkspacesPoolRequest$TimeoutSettings": "Indicates the timeout settings of the specified WorkSpaces pool.
", + "CreateWorkspacesPoolRequest$TimeoutSettings": "Indicates the timeout settings of the pool.
", + "UpdateWorkspacesPoolRequest$TimeoutSettings": "Indicates the timeout settings of the specified pool.
", "WorkspacesPool$TimeoutSettings": "The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
" } }, @@ -2726,9 +2726,9 @@ "UpdateDescription": { "base": null, "refs": { - "CreateWorkspacesPoolRequest$Description": "The WorkSpaces pool description.
", + "CreateWorkspacesPoolRequest$Description": "The pool description.
", "UpdateResult$Description": "A description of whether updates for the WorkSpace image are pending or available.
", - "UpdateWorkspacesPoolRequest$Description": "Describes the specified WorkSpaces pool to update.
", + "UpdateWorkspacesPoolRequest$Description": "Describes the specified pool to update.
", "WorkspacesPool$Description": "The description of the pool.
" } }, @@ -3233,15 +3233,15 @@ } }, "WorkspacesPool": { - "base": "Describes a WorkSpaces pool.
", + "base": "Describes a pool of WorkSpaces.
", "refs": { - "CreateWorkspacesPoolResult$WorkspacesPool": "Indicates the WorkSpaces pool to create.
", - "UpdateWorkspacesPoolResult$WorkspacesPool": "Describes the specified WorkSpaces pool.
", + "CreateWorkspacesPoolResult$WorkspacesPool": "Indicates the pool to create.
", + "UpdateWorkspacesPoolResult$WorkspacesPool": "Describes the specified pool.
", "WorkspacesPools$member": null } }, "WorkspacesPoolError": { - "base": "Describes a WorkSpaces pool error.
", + "base": "Describes a pool error.
", "refs": { "WorkspacesPoolErrors$member": null } @@ -3261,12 +3261,12 @@ "WorkspacesPoolId": { "base": null, "refs": { - "DescribeWorkspacesPoolSessionsRequest$PoolId": "The identifier of the WorkSpaces pool.
", - "StartWorkspacesPoolRequest$PoolId": "The identifier of the WorkSpaces pool.
", - "StopWorkspacesPoolRequest$PoolId": "The identifier of the WorkSpaces pool.
", - "TerminateWorkspacesPoolRequest$PoolId": "The identifier of the WorkSpaces pool.
", - "UpdateWorkspacesPoolRequest$PoolId": "The identifier of the specified WorkSpaces pool to update.
", - "WorkspacesPool$PoolId": "The identifier of a WorkSpaces pool.
", + "DescribeWorkspacesPoolSessionsRequest$PoolId": "The identifier of the pool.
", + "StartWorkspacesPoolRequest$PoolId": "The identifier of the pool.
", + "StopWorkspacesPoolRequest$PoolId": "The identifier of the pool.
", + "TerminateWorkspacesPoolRequest$PoolId": "The identifier of the pool.
", + "UpdateWorkspacesPoolRequest$PoolId": "The identifier of the specified pool to update.
", + "WorkspacesPool$PoolId": "The identifier of a pool.
", "WorkspacesPoolIds$member": null, "WorkspacesPoolSession$PoolId": "The identifier of the pool.
" } @@ -3274,18 +3274,18 @@ "WorkspacesPoolIds": { "base": null, "refs": { - "DescribeWorkspacesPoolsRequest$PoolIds": "The identifier of the WorkSpaces pool.
" + "DescribeWorkspacesPoolsRequest$PoolIds": "The identifier of the WorkSpaces Pools.
" } }, "WorkspacesPoolName": { "base": null, "refs": { - "CreateWorkspacesPoolRequest$PoolName": "The name of the WorkSpaces pool.
", + "CreateWorkspacesPoolRequest$PoolName": "The name of the pool.
", "WorkspacesPool$PoolName": "The name of the pool,
" } }, "WorkspacesPoolSession": { - "base": "Describes a WorkSpaces pool session.
", + "base": "Describes a pool session.
", "refs": { "WorkspacesPoolSessions$member": null } @@ -3293,7 +3293,7 @@ "WorkspacesPoolSessions": { "base": null, "refs": { - "DescribeWorkspacesPoolSessionsResult$Sessions": "Describes the WorkSpaces pool sessions.
" + "DescribeWorkspacesPoolSessionsResult$Sessions": "Describes the pool sessions.
" } }, "WorkspacesPoolState": { @@ -3312,7 +3312,7 @@ "WorkspacesPools": { "base": null, "refs": { - "DescribeWorkspacesPoolsResult$WorkspacesPools": "Information about the WorkSpaces pools.
" + "DescribeWorkspacesPoolsResult$WorkspacesPools": "Information about the WorkSpaces Pools.
" } } } diff --git a/src/data/workspaces/2015-04-08/docs-2.json.php b/src/data/workspaces/2015-04-08/docs-2.json.php index f606635a0e..2598e2fed8 100644 --- a/src/data/workspaces/2015-04-08/docs-2.json.php +++ b/src/data/workspaces/2015-04-08/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.
You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.
', 'operations' => [ 'AcceptAccountLinkInvitation' => 'Accepts the account link invitation.
There\'s currently no unlinking capability after you accept the account linking invitation.
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
Associates the specified IP access control group with the specified directory.
', 'AssociateWorkspaceApplication' => 'Associates the specified application to the specified WorkSpace.
', 'AuthorizeIpRules' => 'Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
', 'CopyWorkspaceImage' => 'Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
Creates the account link invitation.
', 'CreateConnectClientAddIn' => 'Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
', 'CreateConnectionAlias' => 'Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'CreateIpGroup' => 'Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don\'t associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
', 'CreateStandbyWorkspaces' => 'Creates a standby WorkSpace in a secondary Region.
', 'CreateTags' => 'Creates the specified tags for the specified WorkSpaces resource.
', 'CreateUpdatedWorkspaceImage' => 'Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
Microsoft Windows updates and other application updates are not included in the update process.
The source WorkSpace image is not deleted. You can delete the source image after you\'ve verified your new updated image and created a new bundle.
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
', 'CreateWorkspaceImage' => 'Creates a new WorkSpace image from an existing WorkSpace.
', 'CreateWorkspaces' => 'Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
The MANUAL
running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
You don\'t need to specify the PCOIP
protocol for Linux bundles because WSP
is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
Creates a pool of WorkSpaces.
', 'DeleteAccountLinkInvitation' => 'Deletes the account link invitation.
', 'DeleteClientBranding' => 'Deletes customized client branding. Client branding allows you to customize your WorkSpace\'s client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you delete your customized client branding, your login portal reverts to the default client branding.
', 'DeleteConnectClientAddIn' => 'Deletes a client-add-in for Amazon Connect that is configured within a directory.
', 'DeleteConnectionAlias' => 'Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
', 'DeleteTags' => 'Deletes the specified tags from the specified WorkSpaces resource.
', 'DeleteWorkspaceBundle' => 'Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
', 'DeleteWorkspaceImage' => 'Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
', 'DeployWorkspaceApplications' => 'Deploys associated applications to the specified WorkSpace
', 'DeregisterWorkspaceDirectory' => 'Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
', 'DescribeAccountModifications' => 'Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
', 'DescribeApplicationAssociations' => 'Describes the associations between the application and the specified associated resources.
', 'DescribeApplications' => 'Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
', 'DescribeBundleAssociations' => 'Describes the associations between the applications and the specified bundle.
', 'DescribeClientBranding' => 'Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
Only device types that have branding information configured will be shown in the response.
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
', 'DescribeConnectClientAddIns' => 'Retrieves a list of Amazon Connect client add-ins that have been created.
', 'DescribeConnectionAliasPermissions' => 'Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'DescribeConnectionAliases' => 'Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'DescribeImageAssociations' => 'Describes the associations between the applications and the specified image.
', 'DescribeIpGroups' => 'Describes one or more of your IP access control groups.
', 'DescribeTags' => 'Describes the specified tags for the specified WorkSpaces resource.
', 'DescribeWorkspaceAssociations' => 'Describes the associations betweens applications and the specified WorkSpace.
', 'DescribeWorkspaceBundles' => 'Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
', 'DescribeWorkspaceDirectories' => 'Describes the available directories that are registered with Amazon WorkSpaces.
', 'DescribeWorkspaceImagePermissions' => 'Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
', 'DescribeWorkspaceImages' => 'Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
', 'DescribeWorkspaceSnapshots' => 'Describes the snapshots for the specified WorkSpace.
', 'DescribeWorkspaces' => 'Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
', 'DescribeWorkspacesConnectionStatus' => 'Describes the connection status of the specified WorkSpaces.
', 'DescribeWorkspacesPoolSessions' => 'Retrieves a list that describes the streaming sessions for a specified WorkSpaces pool.
', 'DescribeWorkspacesPools' => 'Describes the specified WorkSpaces pool.
', 'DisassociateConnectionAlias' => 'Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
Disassociates the specified IP access control group from the specified directory.
', 'DisassociateWorkspaceApplication' => 'Disassociates the specified application from a WorkSpace.
', 'GetAccountLink' => 'Retrieves account link information.
', 'ImportClientBranding' => 'Imports client branding. Client branding allows you to customize your WorkSpace\'s client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
You must specify at least one platform type when importing client branding.
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
Imported data can take up to a minute to appear in the WorkSpaces client.
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
', 'ListAccountLinks' => 'Lists all account links.
', 'ListAvailableManagementCidrRanges' => 'Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn\'t enabled for BYOL, you\'ll receive an AccessDeniedException
error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
', 'MigrateWorkspace' => 'Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\\Users\\%USERNAME%
user profile folder is renamed to D:\\Users\\%USERNAME%MMddyyTHHmmss%.NotMigrated
. A new D:\\Users\\%USERNAME%\\
folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
', 'ModifyAccount' => 'Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
', 'ModifyCertificateBasedAuthProperties' => 'Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
', 'ModifyClientProperties' => 'Modifies the properties of the specified Amazon WorkSpaces clients.
', 'ModifySamlProperties' => 'Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
', 'ModifySelfservicePermissions' => 'Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
', 'ModifyStreamingProperties' => 'Modifies the specified streaming properties.
', 'ModifyWorkspaceAccessProperties' => 'Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
', 'ModifyWorkspaceCreationProperties' => 'Modify the default properties used to create WorkSpaces.
', 'ModifyWorkspaceProperties' => 'Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The MANUAL
running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE
. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE
state.
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE
, UNHEALTHY
, or REBOOTING
. Reboot a WorkSpace in the REBOOTING
state only if your WorkSpace has been stuck in the REBOOTING
state for over 20 minutes.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
', 'RebuildWorkspaces' => 'Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
, UNHEALTHY
, STOPPED
, or REBOOTING
.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
', 'RegisterWorkspaceDirectory' => 'Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
', 'RejectAccountLinkInvitation' => 'Rejects the account link invitation.
', 'RestoreWorkspace' => 'Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE
, ERROR
, UNHEALTHY
, or STOPPED
.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
', 'RevokeIpRules' => 'Removes one or more rules from the specified IP access control group.
', 'StartWorkspaces' => 'Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop
and a state of STOPPED
.
Starts the specified WorkSpaces pool.
You cannot start a WorkSpace pool unless it has a running mode of AutoStop
and a state of STOPPED
.
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
Stops the specifiedWorkSpaces pool.
You cannot stop a WorkSpace pool unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user\'s data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED
.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED
state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn\'t returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Terminates the specified WorkSpaces pool.
', 'TerminateWorkspacesPoolSession' => 'Terminates the WorkSpaces pool session.
', 'UpdateConnectClientAddIn' => 'Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
', 'UpdateConnectionAliasPermission' => 'Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Replaces the current rules of the specified IP access control group with the specified rules.
', 'UpdateWorkspaceBundle' => 'Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren\'t automatically updated when you update the bundle that they\'re based on. To update existing WorkSpaces that are based on a bundle that you\'ve updated, you must either rebuild the WorkSpaces or delete and recreate them.
Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn\'t supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.
Updates the specified WorkSpaces pool.
', ], 'shapes' => [ 'ARN' => [ 'base' => NULL, 'refs' => [ 'DefaultWorkspaceCreationProperties$InstanceIamRoleArn' => 'Indicates the IAM role ARN of the instance.
', 'WorkspaceCreationProperties$InstanceIamRoleArn' => 'Indicates the IAM role ARN of the instance.
', 'WorkspaceDirectory$IamRoleId' => 'The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
', 'WorkspacesPool$PoolArn' => 'The Amazon Resource Name (ARN) for the WorkSpaces pool.
', ], ], 'AcceptAccountLinkInvitationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptAccountLinkInvitationResult' => [ 'base' => NULL, 'refs' => [], ], 'AccessDeniedException' => [ 'base' => 'The user is not authorized to access a resource.
', 'refs' => [], ], 'AccessPropertyValue' => [ 'base' => NULL, 'refs' => [ 'WorkspaceAccessProperties$DeviceTypeWindows' => 'Indicates whether users can use Windows clients to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeOsx' => 'Indicates whether users can use macOS clients to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeWeb' => 'Indicates whether users can access their WorkSpaces through a web browser.
', 'WorkspaceAccessProperties$DeviceTypeIos' => 'Indicates whether users can use iOS devices to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeAndroid' => 'Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeChromeOs' => 'Indicates whether users can use Chromebooks to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeZeroClient' => 'Indicates whether users can use zero client devices to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeLinux' => 'Indicates whether users can use Linux clients to access their WorkSpaces.
', ], ], 'AccountLink' => [ 'base' => 'Information about about the account link.
', 'refs' => [ 'AcceptAccountLinkInvitationResult$AccountLink' => 'Information about the account link.
', 'AccountLinkList$member' => NULL, 'CreateAccountLinkInvitationResult$AccountLink' => 'Information about the account link.
', 'DeleteAccountLinkInvitationResult$AccountLink' => 'Information about the account link.
', 'GetAccountLinkResult$AccountLink' => 'The account link of the account link to retrieve.
', 'RejectAccountLinkInvitationResult$AccountLink' => 'Information about the account link.
', ], ], 'AccountLinkList' => [ 'base' => NULL, 'refs' => [ 'ListAccountLinksResult$AccountLinks' => 'Information about the account links.
', ], ], 'AccountLinkStatusEnum' => [ 'base' => NULL, 'refs' => [ 'AccountLink$AccountLinkStatus' => 'The status of the account link.
', 'LinkStatusFilterList$member' => NULL, ], ], 'AccountModification' => [ 'base' => 'Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.
', 'refs' => [ 'AccountModificationList$member' => NULL, ], ], 'AccountModificationList' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountModificationsResult$AccountModifications' => 'The list of modifications to the configuration of BYOL.
', ], ], 'ActiveDirectoryConfig' => [ 'base' => 'Information about the Active Directory config.
', 'refs' => [ 'RegisterWorkspaceDirectoryRequest$ActiveDirectoryConfig' => 'The active directory config of the directory.
', 'WorkspaceDirectory$ActiveDirectoryConfig' => 'Information about the Active Directory config.
', ], ], 'ActiveUserSessions' => [ 'base' => NULL, 'refs' => [ 'CapacityStatus$ActiveUserSessions' => 'The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.
', ], ], 'ActualUserSessions' => [ 'base' => NULL, 'refs' => [ 'CapacityStatus$ActualUserSessions' => 'The total number of session slots that are available for WorkSpaces pools.
', ], ], 'AddInName' => [ 'base' => NULL, 'refs' => [ 'ConnectClientAddIn$Name' => 'The name of the client add in.
', 'CreateConnectClientAddInRequest$Name' => 'The name of the client add-in.
', 'UpdateConnectClientAddInRequest$Name' => 'The name of the client add-in.
', ], ], 'AddInUrl' => [ 'base' => NULL, 'refs' => [ 'ConnectClientAddIn$URL' => 'The endpoint URL of the client add-in.
', 'CreateConnectClientAddInRequest$URL' => 'The endpoint URL of the Amazon Connect client add-in.
', 'UpdateConnectClientAddInRequest$URL' => 'The endpoint URL of the Amazon Connect client add-in.
', ], ], 'Alias' => [ 'base' => NULL, 'refs' => [ 'WorkspaceDirectory$Alias' => 'The directory alias.
', ], ], 'AmazonUuid' => [ 'base' => NULL, 'refs' => [ 'ConnectClientAddIn$AddInId' => 'The client add-in identifier.
', 'CreateConnectClientAddInResult$AddInId' => 'The client add-in identifier.
', 'DeleteConnectClientAddInRequest$AddInId' => 'The identifier of the client add-in to delete.
', 'TerminateWorkspacesPoolSessionRequest$SessionId' => 'The identifier of the WorkSpaces pool session.
', 'UpdateConnectClientAddInRequest$AddInId' => 'The identifier of the client add-in to update.
', 'WorkspacesPoolSession$SessionId' => 'The identifier of the session.
', ], ], 'Application' => [ 'base' => NULL, 'refs' => [ 'ApplicationList$member' => NULL, ], ], 'ApplicationAssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'ApplicationAssociatedResourceTypeList$member' => NULL, 'ApplicationResourceAssociation$AssociatedResourceType' => 'The resource type of the associated resource.
', ], ], 'ApplicationAssociatedResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationAssociationsRequest$AssociatedResourceTypes' => 'The resource type of the associated resources.
', ], ], 'ApplicationList' => [ 'base' => NULL, 'refs' => [ 'ImportWorkspaceImageRequest$Applications' => 'If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
Windows 11 only supports Microsoft_Office_2019
.
The specified application is not supported.
', 'refs' => [], ], 'ApplicationResourceAssociation' => [ 'base' => 'Describes the association between an application and an application resource.
', 'refs' => [ 'ApplicationResourceAssociationList$member' => NULL, ], ], 'ApplicationResourceAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationAssociationsResult$Associations' => 'List of associations and information about them.
', ], ], 'ApplicationSettingsRequest' => [ 'base' => 'The persistent application settings for users of a WorkSpaces pool.
', 'refs' => [ 'CreateWorkspacesPoolRequest$ApplicationSettings' => 'Indicates the application settings of the WorkSpaces pool.
', 'UpdateWorkspacesPoolRequest$ApplicationSettings' => 'The persistent application settings for users in the pool.
', ], ], 'ApplicationSettingsResponse' => [ 'base' => 'Describes the persistent application settings for users of a WorkSpaces pool.
', 'refs' => [ 'WorkspacesPool$ApplicationSettings' => 'The persistent application settings for users of the pool.
', ], ], 'ApplicationSettingsStatusEnum' => [ 'base' => NULL, 'refs' => [ 'ApplicationSettingsRequest$Status' => 'Enables or disables persistent application settings for users during their pool sessions.
', 'ApplicationSettingsResponse$Status' => 'Specifies whether persistent application settings are enabled for users during their pool sessions.
', ], ], 'AssociateConnectionAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateConnectionAliasResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociateIpGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateIpGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociateWorkspaceApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateWorkspaceApplicationResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociationErrorCode' => [ 'base' => NULL, 'refs' => [ 'AssociationStateReason$ErrorCode' => 'The error code of the association deployment failure.
', ], ], 'AssociationState' => [ 'base' => NULL, 'refs' => [ 'ApplicationResourceAssociation$State' => 'The status of the application resource association.
', 'BundleResourceAssociation$State' => 'The status of the bundle resource association.
', 'ImageResourceAssociation$State' => 'The status of the image resource association.
', 'WorkspaceResourceAssociation$State' => 'The status of the WorkSpace resource association.
', ], ], 'AssociationStateReason' => [ 'base' => 'Indicates the reason that the association deployment failed, including the error code and error message.
', 'refs' => [ 'ApplicationResourceAssociation$StateReason' => 'The reason the association deployment failed.
', 'BundleResourceAssociation$StateReason' => 'The reason the association deployment failed.
', 'ImageResourceAssociation$StateReason' => 'The reason the association deployment failed.
', 'WorkspaceResourceAssociation$StateReason' => 'The reason the association deployment failed.
', ], ], 'AssociationStatus' => [ 'base' => NULL, 'refs' => [ 'ConnectionAliasAssociation$AssociationStatus' => 'The association status of the connection alias.
', ], ], 'AuthenticationType' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolSession$AuthenticationType' => 'The authentication method. The user is authenticated using a WorkSpaces pool URL (API) or SAML 2.0 federation (SAML).
', ], ], 'AuthorizeIpRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizeIpRulesResult' => [ 'base' => NULL, 'refs' => [], ], 'AvailableUserSessions' => [ 'base' => NULL, 'refs' => [ 'CapacityStatus$AvailableUserSessions' => 'The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.
', ], ], 'AwsAccount' => [ 'base' => NULL, 'refs' => [ 'AccountLink$SourceAccountId' => 'The identifier of the source account.
', 'AccountLink$TargetAccountId' => 'The identifier of the target account.
', 'ConnectionAlias$OwnerAccountId' => 'The identifier of the Amazon Web Services account that owns the connection alias.
', 'ConnectionAliasAssociation$AssociatedAccountId' => 'The identifier of the Amazon Web Services account that associated the connection alias with a directory.
', 'ConnectionAliasPermission$SharedAccountId' => 'The identifier of the Amazon Web Services account that the connection alias is shared with.
', 'CreateAccountLinkInvitationRequest$TargetAccountId' => 'The identifier of the target account.
', 'CreateWorkspaceImageResult$OwnerAccountId' => 'The identifier of the Amazon Web Services account that owns the image.
', 'GetAccountLinkRequest$LinkedAccountId' => 'The identifier of the account link
', 'ImagePermission$SharedAccountId' => 'The identifier of the Amazon Web Services account that an image has been shared with.
', 'UpdateWorkspaceImagePermissionRequest$SharedAccountId' => 'The identifier of the Amazon Web Services account to share or unshare the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
The identifier of the Amazon Web Services account that owns the image.
', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'ConnectionAliasPermission$AllowAssociation' => 'Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
', 'DefaultWorkspaceCreationProperties$EnableWorkDocs' => 'Specifies whether the directory is enabled for Amazon WorkDocs.
', 'DefaultWorkspaceCreationProperties$EnableInternetAccess' => 'Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you\'re using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
', 'DefaultWorkspaceCreationProperties$UserEnabledAsLocalAdministrator' => 'Specifies whether WorkSpace users are local administrators on their WorkSpaces.
', 'DefaultWorkspaceCreationProperties$EnableMaintenanceMode' => 'Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
', 'DeployWorkspaceApplicationsRequest$Force' => 'Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.
', 'RegisterWorkspaceDirectoryRequest$EnableWorkDocs' => 'Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs
to disabled, and try again.
Indicates whether self-service capabilities are enabled or disabled.
', 'UpdateResult$UpdateAvailable' => 'Indicates whether updated drivers or other components are available for the specified WorkSpace image.
', 'UpdateWorkspaceImagePermissionRequest$AllowCopyImage' => 'The permission to copy the image. This permission can be revoked only after an image has been shared.
', 'Workspace$UserVolumeEncryptionEnabled' => 'Indicates whether the data stored on the user volume is encrypted.
', 'Workspace$RootVolumeEncryptionEnabled' => 'Indicates whether the data stored on the root volume is encrypted.
', 'WorkspaceCreationProperties$EnableWorkDocs' => 'Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users\' access to WorkDocs or you delete the WorkDocs site. To disable users\' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
Indicates whether internet access is enabled for your WorkSpaces.
', 'WorkspaceCreationProperties$UserEnabledAsLocalAdministrator' => 'Indicates whether users are local administrators of their WorkSpaces.
', 'WorkspaceCreationProperties$EnableMaintenanceMode' => 'Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
', 'WorkspaceRequest$UserVolumeEncryptionEnabled' => 'Indicates whether the data stored on the user volume is encrypted.
', 'WorkspaceRequest$RootVolumeEncryptionEnabled' => 'Indicates whether the data stored on the root volume is encrypted.
', ], ], 'BundleAssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'BundleAssociatedResourceTypeList$member' => NULL, 'BundleResourceAssociation$AssociatedResourceType' => 'The resource type of the associated resources.
', ], ], 'BundleAssociatedResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeBundleAssociationsRequest$AssociatedResourceTypes' => 'The resource types of the associated resource.
', ], ], 'BundleId' => [ 'base' => NULL, 'refs' => [ 'BundleIdList$member' => NULL, 'BundleResourceAssociation$BundleId' => 'The identifier of the bundle.
', 'CreateWorkspacesPoolRequest$BundleId' => 'The identifier of the bundle for the WorkSpaces pool.
', 'DeleteWorkspaceBundleRequest$BundleId' => 'The identifier of the bundle.
', 'DescribeBundleAssociationsRequest$BundleId' => 'The identifier of the bundle.
', 'DescribeWorkspacesRequest$BundleId' => 'The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
', 'MigrateWorkspaceRequest$BundleId' => 'The identifier of the target bundle type to migrate the WorkSpace to.
', 'UpdateWorkspaceBundleRequest$BundleId' => 'The identifier of the bundle.
', 'UpdateWorkspacesPoolRequest$BundleId' => 'The identifier of the bundle.
', 'Workspace$BundleId' => 'The identifier of the bundle used to create the WorkSpace.
', 'WorkspaceBundle$BundleId' => 'The identifier of the bundle.
', 'WorkspaceRequest$BundleId' => 'The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
', 'WorkspacesPool$BundleId' => 'The identifier of the bundle used by the pool.
', ], ], 'BundleIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceBundlesRequest$BundleIds' => 'The identifiers of the bundles. You cannot combine this parameter with any other filter.
', ], ], 'BundleList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceBundlesResult$Bundles' => 'Information about the bundles.
', ], ], 'BundleOwner' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceBundlesRequest$Owner' => 'The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON
. To describe the bundles that belong to your account, don\'t specify a value.
The owner of the bundle. This is the account identifier of the owner, or AMAZON
if the bundle is provided by Amazon Web Services.
Describes the association between an application and a bundle resource.
', 'refs' => [ 'BundleResourceAssociationList$member' => NULL, ], ], 'BundleResourceAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeBundleAssociationsResult$Associations' => 'List of information about the specified associations.
', ], ], 'BundleType' => [ 'base' => NULL, 'refs' => [ 'WorkspaceBundle$BundleType' => 'The type of WorkSpace bundle.
', ], ], 'Capacity' => [ 'base' => 'Describes the user capacity for a WorkSpaces pool.
', 'refs' => [ 'CreateWorkspacesPoolRequest$Capacity' => 'The user capacity of the WorkSpaces pool.
', 'UpdateWorkspacesPoolRequest$Capacity' => 'The desired capacity for the WorkSpaces pool.
', ], ], 'CapacityStatus' => [ 'base' => 'Describes the capacity status for a WorkSpaces pool
', 'refs' => [ 'WorkspacesPool$CapacityStatus' => 'The capacity status for the pool
', ], ], 'CertificateAuthorityArn' => [ 'base' => NULL, 'refs' => [ 'CertificateBasedAuthProperties$CertificateAuthorityArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
', ], ], 'CertificateBasedAuthProperties' => [ 'base' => 'Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.
', 'refs' => [ 'ModifyCertificateBasedAuthPropertiesRequest$CertificateBasedAuthProperties' => 'The properties of the certificate-based authentication.
', 'WorkspaceDirectory$CertificateBasedAuthProperties' => 'The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
', ], ], 'CertificateBasedAuthStatusEnum' => [ 'base' => NULL, 'refs' => [ 'CertificateBasedAuthProperties$Status' => 'The status of the certificate-based authentication properties.
', ], ], 'ClientDeviceType' => [ 'base' => NULL, 'refs' => [ 'ClientDeviceTypeList$member' => NULL, ], ], 'ClientDeviceTypeList' => [ 'base' => NULL, 'refs' => [ 'DeleteClientBrandingRequest$Platforms' => 'The device type for which you want to delete client branding.
', ], ], 'ClientEmail' => [ 'base' => NULL, 'refs' => [ 'DefaultClientBrandingAttributes$SupportEmail' => 'The support email. The company\'s customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com
.
The support email. The company\'s customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com
.
The support email. The company\'s customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com
.
The support email. The company\'s customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com
.
Describes an Amazon WorkSpaces client.
', 'refs' => [ 'ClientPropertiesResult$ClientProperties' => 'Information about the Amazon WorkSpaces client.
', 'ModifyClientPropertiesRequest$ClientProperties' => 'Information about the Amazon WorkSpaces client.
', ], ], 'ClientPropertiesList' => [ 'base' => NULL, 'refs' => [ 'DescribeClientPropertiesResult$ClientPropertiesList' => 'Information about the specified Amazon WorkSpaces clients.
', ], ], 'ClientPropertiesResult' => [ 'base' => 'Information about the Amazon WorkSpaces client.
', 'refs' => [ 'ClientPropertiesList$member' => NULL, ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'AcceptAccountLinkInvitationRequest$ClientToken' => 'A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
', 'CreateAccountLinkInvitationRequest$ClientToken' => 'A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
', 'DeleteAccountLinkInvitationRequest$ClientToken' => 'A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
', 'RejectAccountLinkInvitationRequest$ClientToken' => 'The client token of the account link invitation to reject.
', ], ], 'ClientUrl' => [ 'base' => NULL, 'refs' => [ 'DefaultClientBrandingAttributes$LogoUrl' => 'The logo. The only image format accepted is a binary data object that is converted from a .png
file.
The support link. The link for the company\'s customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com
.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
', 'DefaultImportClientBrandingAttributes$SupportLink' => 'The support link. The link for the company\'s customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com
.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
', 'IosClientBrandingAttributes$LogoUrl' => 'The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png
file.
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The support link. The link for the company\'s customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com
.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
', 'IosImportClientBrandingAttributes$SupportLink' => 'The support link. The link for the company\'s customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com
.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
', ], ], 'Compute' => [ 'base' => NULL, 'refs' => [ 'ComputeList$member' => NULL, 'ComputeType$Name' => 'The compute type.
', 'WorkspaceProperties$ComputeTypeName' => 'The compute type. For more information, see Amazon WorkSpaces Bundles.
', ], ], 'ComputeList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$ComputeTypeNames' => 'The compute types supported by the applications.
', 'WorkSpaceApplication$SupportedComputeTypeNames' => 'The supported compute types of the WorkSpace application.
', ], ], 'ComputeNotCompatibleException' => [ 'base' => 'The compute type of the WorkSpace is not compatible with the application.
', 'refs' => [], ], 'ComputeType' => [ 'base' => 'Describes the compute type of the bundle.
', 'refs' => [ 'CreateWorkspaceBundleRequest$ComputeType' => NULL, 'WorkspaceBundle$ComputeType' => 'The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
', ], ], 'ComputerName' => [ 'base' => NULL, 'refs' => [ 'Workspace$ComputerName' => 'The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
', ], ], 'ConflictException' => [ 'base' => 'The TargetAccountId
is already linked or invited.
Describes an Amazon Connect client add-in.
', 'refs' => [ 'ConnectClientAddInList$member' => NULL, ], ], 'ConnectClientAddInList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectClientAddInsResult$AddIns' => 'Information about client add-ins.
', ], ], 'ConnectionAlias' => [ 'base' => 'Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'refs' => [ 'ConnectionAliasList$member' => NULL, ], ], 'ConnectionAliasAssociation' => [ 'base' => 'Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'refs' => [ 'ConnectionAliasAssociationList$member' => NULL, ], ], 'ConnectionAliasAssociationList' => [ 'base' => NULL, 'refs' => [ 'ConnectionAlias$Associations' => 'The association status of the connection alias.
', ], ], 'ConnectionAliasId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectionAliasRequest$AliasId' => 'The identifier of the connection alias.
', 'ConnectionAlias$AliasId' => 'The identifier of the connection alias.
', 'ConnectionAliasIdList$member' => NULL, 'CreateConnectionAliasResult$AliasId' => 'The identifier of the connection alias.
', 'DeleteConnectionAliasRequest$AliasId' => 'The identifier of the connection alias to delete.
', 'DescribeConnectionAliasPermissionsRequest$AliasId' => 'The identifier of the connection alias.
', 'DescribeConnectionAliasPermissionsResult$AliasId' => 'The identifier of the connection alias.
', 'DisassociateConnectionAliasRequest$AliasId' => 'The identifier of the connection alias to disassociate.
', 'UpdateConnectionAliasPermissionRequest$AliasId' => 'The identifier of the connection alias that you want to update permissions for.
', ], ], 'ConnectionAliasIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectionAliasesRequest$AliasIds' => 'The identifiers of the connection aliases to describe.
', ], ], 'ConnectionAliasList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectionAliasesResult$ConnectionAliases' => 'Information about the specified connection aliases.
', ], ], 'ConnectionAliasPermission' => [ 'base' => 'Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'refs' => [ 'ConnectionAliasPermissions$member' => NULL, 'UpdateConnectionAliasPermissionRequest$ConnectionAliasPermission' => 'Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.
', ], ], 'ConnectionAliasPermissions' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectionAliasPermissionsResult$ConnectionAliasPermissions' => 'The permissions associated with a connection alias.
', ], ], 'ConnectionAliasState' => [ 'base' => NULL, 'refs' => [ 'ConnectionAlias$State' => 'The current state of the connection alias.
', ], ], 'ConnectionIdentifier' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectionAliasResult$ConnectionIdentifier' => 'The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you\'re configuring your DNS routing policies.
', 'ConnectionAliasAssociation$ConnectionIdentifier' => 'The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you\'re configuring your DNS routing policies.
', ], ], 'ConnectionState' => [ 'base' => NULL, 'refs' => [ 'WorkspaceConnectionStatus$ConnectionState' => 'The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
', ], ], 'ConnectionString' => [ 'base' => NULL, 'refs' => [ 'ConnectionAlias$ConnectionString' => 'The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com
.
A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com
.
After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
Indicates whether data replication is enabled, and if enabled, the type of data replication.
', 'ModifyWorkspacePropertiesRequest$DataReplication' => 'Indicates the data replication status.
', 'StandbyWorkspace$DataReplication' => 'Indicates whether data replication is enabled, and if enabled, the type of data replication.
', 'StandbyWorkspacesProperties$DataReplication' => 'Indicates whether data replication is enabled, and if enabled, the type of data replication.
', ], ], 'DataReplicationSettings' => [ 'base' => 'Describes the data replication settings.
', 'refs' => [ 'Workspace$DataReplicationSettings' => 'Indicates the settings of the data replication.
', ], ], 'DedicatedTenancyAccountType' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountResult$DedicatedTenancyAccountType' => 'The type of linked account.
', ], ], 'DedicatedTenancyCidrRangeList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableManagementCidrRangesResult$ManagementCidrRanges' => 'The list of available IP address ranges, specified as IPv4 CIDR blocks.
', ], ], 'DedicatedTenancyManagementCidrRange' => [ 'base' => NULL, 'refs' => [ 'AccountModification$DedicatedTenancyManagementCidrRange' => 'The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
', 'DedicatedTenancyCidrRangeList$member' => NULL, 'DescribeAccountResult$DedicatedTenancyManagementCidrRange' => 'The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
', 'ModifyAccountRequest$DedicatedTenancyManagementCidrRange' => 'The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges
operation.
The state of the modification to the configuration of BYOL.
', ], ], 'DedicatedTenancySupportEnum' => [ 'base' => NULL, 'refs' => [ 'ModifyAccountRequest$DedicatedTenancySupport' => 'The status of BYOL.
', ], ], 'DedicatedTenancySupportResultEnum' => [ 'base' => NULL, 'refs' => [ 'AccountModification$DedicatedTenancySupport' => 'The status of BYOL (whether BYOL is being enabled or disabled).
', 'DescribeAccountResult$DedicatedTenancySupport' => 'The status of BYOL (whether BYOL is enabled or disabled).
', ], ], 'DefaultClientBrandingAttributes' => [ 'base' => 'Returns default client branding attributes that were imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you don\'t include sensitive information.
The branding information for Windows devices.
', 'DescribeClientBrandingResult$DeviceTypeOsx' => 'The branding information for macOS devices.
', 'DescribeClientBrandingResult$DeviceTypeAndroid' => 'The branding information for Android devices.
', 'DescribeClientBrandingResult$DeviceTypeLinux' => 'The branding information for Linux devices.
', 'DescribeClientBrandingResult$DeviceTypeWeb' => 'The branding information for Web access.
', 'ImportClientBrandingResult$DeviceTypeWindows' => 'The branding information configured for Windows devices.
', 'ImportClientBrandingResult$DeviceTypeOsx' => 'The branding information configured for macOS devices.
', 'ImportClientBrandingResult$DeviceTypeAndroid' => 'The branding information configured for Android devices.
', 'ImportClientBrandingResult$DeviceTypeLinux' => 'The branding information configured for Linux devices.
', 'ImportClientBrandingResult$DeviceTypeWeb' => 'The branding information configured for web access.
', ], ], 'DefaultImportClientBrandingAttributes' => [ 'base' => 'The default client branding attributes to be imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you do not include sensitive information.
The branding information to import for Windows devices.
', 'ImportClientBrandingRequest$DeviceTypeOsx' => 'The branding information to import for macOS devices.
', 'ImportClientBrandingRequest$DeviceTypeAndroid' => 'The branding information to import for Android devices.
', 'ImportClientBrandingRequest$DeviceTypeLinux' => 'The branding information to import for Linux devices.
', 'ImportClientBrandingRequest$DeviceTypeWeb' => 'The branding information to import for web access.
', ], ], 'DefaultLogo' => [ 'base' => NULL, 'refs' => [ 'DefaultImportClientBrandingAttributes$Logo' => 'The logo. The only image format accepted is a binary data object that is converted from a .png
file.
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
', 'WorkspaceCreationProperties$DefaultOu' => 'The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value"
, where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com
.
To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
The API doesn\'t validate whether the OU exists.
Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
', 'refs' => [ 'WorkspaceDirectory$WorkspaceCreationProperties' => 'The default creation properties for all WorkSpaces in the directory.
', ], ], 'DeletableCertificateBasedAuthPropertiesList' => [ 'base' => NULL, 'refs' => [ 'ModifyCertificateBasedAuthPropertiesRequest$PropertiesToDelete' => 'The properties of the certificate-based authentication you want to delete.
', ], ], 'DeletableCertificateBasedAuthProperty' => [ 'base' => NULL, 'refs' => [ 'DeletableCertificateBasedAuthPropertiesList$member' => NULL, ], ], 'DeletableSamlPropertiesList' => [ 'base' => NULL, 'refs' => [ 'ModifySamlPropertiesRequest$PropertiesToDelete' => 'The SAML properties to delete as part of your request.
Specify one of the following options:
SAML_PROPERTIES_USER_ACCESS_URL
to delete the user access URL.
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
to delete the relay state parameter name.
Describes the filter conditions for the WorkSpaces pool to return.
', 'refs' => [ 'DescribeWorkspacesPoolsFilters$member' => NULL, ], ], 'DescribeWorkspacesPoolsFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsFilter$Name' => 'The name of the pool to filter.
', ], ], 'DescribeWorkspacesPoolsFilterOperator' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsFilter$Operator' => 'The operator values for filtering WorkSpaces pools.
', ], ], 'DescribeWorkspacesPoolsFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsFilterValues$member' => NULL, ], ], 'DescribeWorkspacesPoolsFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsFilter$Values' => 'The values for filtering WorkSpaces pools.
', ], ], 'DescribeWorkspacesPoolsFilters' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsRequest$Filters' => 'The filter conditions for the WorkSpaces pool to return.
', ], ], 'DescribeWorkspacesPoolsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkspacesPoolsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AccountModification$ErrorMessage' => 'The text of the error message that is returned if the configuration of BYOL cannot be modified.
', 'ErrorDetails$ErrorMessage' => 'The text of the error message related the error code.
', 'FailedCreateStandbyWorkspacesRequest$ErrorMessage' => 'The text of the error message that is returned if the standby WorkSpace could not be created.
', 'FailedCreateWorkspaceRequest$ErrorMessage' => 'The text of the error message that is returned if the WorkSpace cannot be created.
', 'FailedWorkspaceChangeRequest$ErrorMessage' => 'The text of the error message that is returned if the WorkSpace cannot be rebooted.
', 'Workspace$ErrorMessage' => 'The text of the error message that is returned if the WorkSpace cannot be created.
', 'WorkspaceBundle$Description' => 'The description of the bundle.
', 'WorkspaceDirectory$ErrorMessage' => 'The error message returned.
', 'WorkspaceImage$ErrorMessage' => 'The text of the error message that is returned for the image.
', ], ], 'DesiredUserSessions' => [ 'base' => NULL, 'refs' => [ 'Capacity$DesiredUserSessions' => 'The desired number of user sessions for a multi-session pool. This is not allowed for single-session pools.
', 'CapacityStatus$DesiredUserSessions' => 'The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.
', ], ], 'DirectoryId' => [ 'base' => NULL, 'refs' => [ 'AssociateIpGroupsRequest$DirectoryId' => 'The identifier of the directory.
', 'ConnectClientAddIn$ResourceId' => 'The directory identifier for which the client add-in is configured.
', 'CreateConnectClientAddInRequest$ResourceId' => 'The directory identifier for which to configure the client add-in.
', 'CreateWorkspacesPoolRequest$DirectoryId' => 'The identifier of the directory for the WorkSpaces pool.
', 'DeleteClientBrandingRequest$ResourceId' => 'The directory identifier of the WorkSpace for which you want to delete client branding.
', 'DeleteConnectClientAddInRequest$ResourceId' => 'The directory identifier for which the client add-in is configured.
', 'DeregisterWorkspaceDirectoryRequest$DirectoryId' => 'The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
', 'DescribeClientBrandingRequest$ResourceId' => 'The directory identifier of the WorkSpace for which you want to view client branding information.
', 'DescribeConnectClientAddInsRequest$ResourceId' => 'The directory identifier for which the client add-in is configured.
', 'DescribeWorkspacesRequest$DirectoryId' => 'The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName
). You cannot combine this parameter with any other filter.
The identifier of the directory.
', 'ImportClientBrandingRequest$ResourceId' => 'The directory identifier of the WorkSpace for which you want to import client branding.
', 'ModifyCertificateBasedAuthPropertiesRequest$ResourceId' => 'The resource identifiers, in the form of directory IDs.
', 'ModifySamlPropertiesRequest$ResourceId' => 'The directory identifier for which you want to configure SAML properties.
', 'ModifySelfservicePermissionsRequest$ResourceId' => 'The identifier of the directory.
', 'ModifyStreamingPropertiesRequest$ResourceId' => 'The identifier of the resource.
', 'ModifyWorkspaceAccessPropertiesRequest$ResourceId' => 'The identifier of the directory.
', 'ModifyWorkspaceCreationPropertiesRequest$ResourceId' => 'The identifier of the directory.
', 'PendingCreateStandbyWorkspacesRequest$DirectoryId' => 'The identifier of the directory for the standby WorkSpace.
', 'RegisterWorkspaceDirectoryRequest$DirectoryId' => 'The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
', 'RegisterWorkspaceDirectoryResult$DirectoryId' => 'The identifier of the directory.
', 'StandbyWorkspace$DirectoryId' => 'The identifier of the directory for the standby WorkSpace.
', 'UpdateConnectClientAddInRequest$ResourceId' => 'The directory identifier for which the client add-in is configured.
', 'UpdateWorkspacesPoolRequest$DirectoryId' => 'The identifier of the directory.
', 'Workspace$DirectoryId' => 'The identifier of the Directory Service directory for the WorkSpace.
', 'WorkspaceDirectory$DirectoryId' => 'The directory identifier.
', 'WorkspaceRequest$DirectoryId' => 'The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
', 'WorkspacesPool$DirectoryId' => 'The identifier of the directory used by the pool.
', ], ], 'DirectoryIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceDirectoriesRequest$DirectoryIds' => 'The identifiers of the directories. If the value is null, all directories are retrieved.
', ], ], 'DirectoryList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceDirectoriesResult$Directories' => 'Information about the directories.
', ], ], 'DirectoryName' => [ 'base' => NULL, 'refs' => [ 'WorkspaceDirectory$DirectoryName' => 'The name of the directory.
', ], ], 'DisassociateConnectionAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateConnectionAliasResult' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateIpGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateIpGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateWorkspaceApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateWorkspaceApplicationResult' => [ 'base' => NULL, 'refs' => [], ], 'DisconnectTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'TimeoutSettings$DisconnectTimeoutInSeconds' => 'Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
', ], ], 'DnsIpAddresses' => [ 'base' => NULL, 'refs' => [ 'WorkspaceDirectory$DnsIpAddresses' => 'The IP addresses of the DNS servers for the directory.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'ActiveDirectoryConfig$DomainName' => 'The name of the domain.
', ], ], 'Ec2ImageId' => [ 'base' => NULL, 'refs' => [ 'ImportWorkspaceImageRequest$Ec2ImageId' => 'The identifier of the EC2 image.
', ], ], 'ErrorDetails' => [ 'base' => 'Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
', 'refs' => [ 'ErrorDetailsList$member' => NULL, ], ], 'ErrorDetailsList' => [ 'base' => NULL, 'refs' => [ 'WorkspaceImage$ErrorDetails' => 'Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolError$ErrorMessage' => 'The error message.
', ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'FailedCreateWorkspaceRequest$ErrorCode' => 'The error code that is returned if the WorkSpace cannot be created.
', 'FailedWorkspaceChangeRequest$ErrorCode' => 'The error code that is returned if the WorkSpace cannot be rebooted.
', ], ], 'ExceptionErrorCode' => [ 'base' => NULL, 'refs' => [ 'OperationNotSupportedException$reason' => 'The exception error reason.
', ], ], 'ExceptionMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'InternalServerException$message' => NULL, 'InvalidParameterValuesException$message' => 'The exception error message.
', 'InvalidResourceStateException$message' => NULL, 'OperationInProgressException$message' => NULL, 'OperationNotSupportedException$message' => 'The exception error message.
', 'ResourceAlreadyExistsException$message' => NULL, 'ResourceAssociatedException$message' => NULL, 'ResourceCreationFailedException$message' => NULL, 'ResourceInUseException$message' => NULL, 'ResourceLimitExceededException$message' => 'The exception error message.
', 'ResourceNotFoundException$message' => 'The resource could not be found.
', 'ResourceUnavailableException$message' => 'The exception error message.
', 'UnsupportedNetworkConfigurationException$message' => NULL, 'UnsupportedWorkspaceConfigurationException$message' => NULL, 'ValidationException$message' => NULL, 'WorkspacesDefaultRoleNotFoundException$message' => NULL, ], ], 'FailedCreateStandbyWorkspacesRequest' => [ 'base' => 'Describes the standby WorkSpace that could not be created.
', 'refs' => [ 'FailedCreateStandbyWorkspacesRequestList$member' => NULL, ], ], 'FailedCreateStandbyWorkspacesRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateStandbyWorkspacesResult$FailedStandbyRequests' => 'Information about the standby WorkSpace that could not be created.
', ], ], 'FailedCreateWorkspaceRequest' => [ 'base' => 'Describes a WorkSpace that cannot be created.
', 'refs' => [ 'FailedCreateWorkspaceRequests$member' => NULL, ], ], 'FailedCreateWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be created.
', ], ], 'FailedRebootWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'RebootWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be rebooted.
', ], ], 'FailedRebuildWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'RebuildWorkspacesResult$FailedRequests' => 'Information about the WorkSpace that could not be rebuilt.
', ], ], 'FailedStartWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'StartWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be started.
', ], ], 'FailedStopWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'StopWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be stopped.
', ], ], 'FailedTerminateWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'TerminateWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be terminated.
', ], ], 'FailedWorkspaceChangeRequest' => [ 'base' => 'Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
', 'refs' => [ 'FailedRebootWorkspaceRequests$member' => NULL, 'FailedRebuildWorkspaceRequests$member' => NULL, 'FailedStartWorkspaceRequests$member' => NULL, 'FailedStopWorkspaceRequests$member' => NULL, 'FailedTerminateWorkspaceRequests$member' => NULL, ], ], 'GetAccountLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAccountLinkResult' => [ 'base' => NULL, 'refs' => [], ], 'IdleDisconnectTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'TimeoutSettings$IdleDisconnectTimeoutInSeconds' => 'The amount of time in seconds a connection will stay active while idle.
', ], ], 'ImageAssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'ImageAssociatedResourceTypeList$member' => NULL, 'ImageResourceAssociation$AssociatedResourceType' => 'The resource type of the associated resources.
', ], ], 'ImageAssociatedResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeImageAssociationsRequest$AssociatedResourceTypes' => 'The resource types of the associated resource.
', ], ], 'ImagePermission' => [ 'base' => 'Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
', 'refs' => [ 'ImagePermissions$member' => NULL, ], ], 'ImagePermissions' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceImagePermissionsResult$ImagePermissions' => 'The identifiers of the Amazon Web Services accounts that the image has been shared with.
', ], ], 'ImageResourceAssociation' => [ 'base' => 'Describes the association between an application and an image resource.
', 'refs' => [ 'ImageResourceAssociationList$member' => NULL, ], ], 'ImageResourceAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeImageAssociationsResult$Associations' => 'List of information about the specified associations.
', ], ], 'ImageType' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceImagesRequest$ImageType' => 'The type (owned or shared) of the image.
', ], ], 'ImportClientBrandingRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportClientBrandingResult' => [ 'base' => NULL, 'refs' => [], ], 'ImportWorkspaceImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportWorkspaceImageResult' => [ 'base' => NULL, 'refs' => [], ], 'IncompatibleApplicationsException' => [ 'base' => 'The specified application is not compatible with the resource.
', 'refs' => [], ], 'InternalServerException' => [ 'base' => 'Unexpected server error occured.
', 'refs' => [], ], 'InvalidParameterValuesException' => [ 'base' => 'One or more parameter values are not valid.
', 'refs' => [], ], 'InvalidResourceStateException' => [ 'base' => 'The state of the resource is not valid for this operation.
', 'refs' => [], ], 'Ios2XLogo' => [ 'base' => NULL, 'refs' => [ 'IosImportClientBrandingAttributes$Logo2x' => 'The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.
Client branding attributes are public facing. Ensure you do not include sensitive information.
The branding information for iOS devices.
', 'ImportClientBrandingResult$DeviceTypeIos' => 'The branding information configured for iOS devices.
', ], ], 'IosImportClientBrandingAttributes' => [ 'base' => 'The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.
Client branding attributes are public facing. Ensure you do not include sensitive information.
The branding information to import for iOS devices.
', ], ], 'IosLogo' => [ 'base' => NULL, 'refs' => [ 'IosImportClientBrandingAttributes$Logo' => 'The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png
file.
The IP address of the WorkSpace.
', ], ], 'IpGroupDesc' => [ 'base' => NULL, 'refs' => [ 'CreateIpGroupRequest$GroupDesc' => 'The description of the group.
', 'WorkspacesIpGroup$groupDesc' => 'The description of the group.
', ], ], 'IpGroupId' => [ 'base' => NULL, 'refs' => [ 'AuthorizeIpRulesRequest$GroupId' => 'The identifier of the group.
', 'CreateIpGroupResult$GroupId' => 'The identifier of the group.
', 'DeleteIpGroupRequest$GroupId' => 'The identifier of the IP access control group.
', 'IpGroupIdList$member' => NULL, 'RevokeIpRulesRequest$GroupId' => 'The identifier of the group.
', 'UpdateRulesOfIpGroupRequest$GroupId' => 'The identifier of the group.
', 'WorkspacesIpGroup$groupId' => 'The identifier of the group.
', ], ], 'IpGroupIdList' => [ 'base' => NULL, 'refs' => [ 'AssociateIpGroupsRequest$GroupIds' => 'The identifiers of one or more IP access control groups.
', 'DescribeIpGroupsRequest$GroupIds' => 'The identifiers of one or more IP access control groups.
', 'DisassociateIpGroupsRequest$GroupIds' => 'The identifiers of one or more IP access control groups.
', 'WorkspaceDirectory$ipGroupIds' => 'The identifiers of the IP access control groups associated with the directory.
', ], ], 'IpGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateIpGroupRequest$GroupName' => 'The name of the group.
', 'WorkspacesIpGroup$groupName' => 'The name of the group.
', ], ], 'IpRevokedRuleList' => [ 'base' => NULL, 'refs' => [ 'RevokeIpRulesRequest$UserRules' => 'The rules to remove from the group.
', ], ], 'IpRule' => [ 'base' => NULL, 'refs' => [ 'IpRevokedRuleList$member' => NULL, 'IpRuleItem$ipRule' => 'The IP address range, in CIDR notation.
', ], ], 'IpRuleDesc' => [ 'base' => NULL, 'refs' => [ 'IpRuleItem$ruleDesc' => 'The description.
', ], ], 'IpRuleItem' => [ 'base' => 'Describes a rule for an IP access control group.
', 'refs' => [ 'IpRuleList$member' => NULL, ], ], 'IpRuleList' => [ 'base' => NULL, 'refs' => [ 'AuthorizeIpRulesRequest$UserRules' => 'The rules to add to the group.
', 'CreateIpGroupRequest$UserRules' => 'The rules to add to the group.
', 'UpdateRulesOfIpGroupRequest$UserRules' => 'One or more rules.
', 'WorkspacesIpGroup$userRules' => 'The rules.
', ], ], 'Limit' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationAssociationsRequest$MaxResults' => 'The maximum number of associations to return.
', 'DescribeApplicationsRequest$MaxResults' => 'The maximum number of applications to return.
', 'DescribeConnectClientAddInsRequest$MaxResults' => 'The maximum number of items to return.
', 'DescribeConnectionAliasPermissionsRequest$MaxResults' => 'The maximum number of results to return.
', 'DescribeConnectionAliasesRequest$Limit' => 'The maximum number of connection aliases to return.
', 'DescribeIpGroupsRequest$MaxResults' => 'The maximum number of items to return.
', 'DescribeWorkspaceDirectoriesRequest$Limit' => 'The maximum number of directories to return.
', 'DescribeWorkspaceImagePermissionsRequest$MaxResults' => 'The maximum number of items to return.
', 'DescribeWorkspaceImagesRequest$MaxResults' => 'The maximum number of items to return.
', 'DescribeWorkspacesPoolsRequest$Limit' => 'The maximum number of items to return.
', 'DescribeWorkspacesRequest$Limit' => 'The maximum number of items to return.
', 'ListAccountLinksRequest$MaxResults' => 'The maximum number of accounts to return.
', ], ], 'Limit50' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolSessionsRequest$Limit' => 'The maximum number of items to return.
', ], ], 'LinkId' => [ 'base' => NULL, 'refs' => [ 'AcceptAccountLinkInvitationRequest$LinkId' => 'The identifier of the account link.
', 'AccountLink$AccountLinkId' => 'The identifier of the account link.
', 'DeleteAccountLinkInvitationRequest$LinkId' => 'The identifier of the account link.
', 'GetAccountLinkRequest$LinkId' => 'The identifier of the account to link.
', 'RejectAccountLinkInvitationRequest$LinkId' => 'The identifier of the account link
', ], ], 'LinkStatusFilterList' => [ 'base' => NULL, 'refs' => [ 'ListAccountLinksRequest$LinkStatusFilter' => 'Filters the account based on their link status.
', ], ], 'ListAccountLinksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccountLinksResult' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagementCidrRangesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagementCidrRangesResult' => [ 'base' => NULL, 'refs' => [], ], 'LogUploadEnum' => [ 'base' => NULL, 'refs' => [ 'ClientProperties$LogUploadEnabled' => 'Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.
', ], ], 'LoginMessage' => [ 'base' => NULL, 'refs' => [ 'DefaultClientBrandingAttributes$LoginMessage' => 'The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US
. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US
. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US
. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US
. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
', ], ], 'ManagementCidrRangeMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAvailableManagementCidrRangesRequest$MaxResults' => 'The maximum number of items to return.
', ], ], 'MaxUserDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'TimeoutSettings$MaxUserDurationInSeconds' => 'Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
', ], ], 'MaximumLength' => [ 'base' => NULL, 'refs' => [ 'UserSetting$MaximumLength' => 'Indicates the maximum character length for the specified user setting.
', ], ], 'MigrateWorkspaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'MigrateWorkspaceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModificationResourceEnum' => [ 'base' => NULL, 'refs' => [ 'ModificationState$Resource' => 'The resource.
', ], ], 'ModificationState' => [ 'base' => 'Describes a WorkSpace modification.
', 'refs' => [ 'ModificationStateList$member' => NULL, ], ], 'ModificationStateEnum' => [ 'base' => NULL, 'refs' => [ 'ModificationState$State' => 'The modification state.
', ], ], 'ModificationStateList' => [ 'base' => NULL, 'refs' => [ 'Workspace$ModificationStates' => 'The modification states of the WorkSpace.
', ], ], 'ModifyAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyAccountResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCertificateBasedAuthPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCertificateBasedAuthPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClientPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClientPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifySamlPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifySamlPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifySelfservicePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifySelfservicePermissionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyStreamingPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyStreamingPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceAccessPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceAccessPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceCreationPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceCreationPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspacePropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspacePropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceStateResult' => [ 'base' => NULL, 'refs' => [], ], 'NetworkAccessConfiguration' => [ 'base' => 'Describes the network details of a WorkSpaces pool.
', 'refs' => [ 'WorkspacesPoolSession$NetworkAccessConfiguration' => 'Describes the network details of the pool.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'ApplicationResourceAssociation$AssociatedResourceId' => 'The identifier of the associated resource.
', 'AssociateConnectionAliasRequest$ResourceId' => 'The identifier of the directory to associate the connection alias with.
', 'BundleResourceAssociation$AssociatedResourceId' => 'The identifier of the associated resource.
', 'ClientPropertiesResult$ResourceId' => 'The resource identifier, in the form of a directory ID.
', 'ConnectionAliasAssociation$ResourceId' => 'The identifier of the directory associated with a connection alias.
', 'CreateTagsRequest$ResourceId' => 'The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
', 'DeleteTagsRequest$ResourceId' => 'The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
', 'DescribeConnectionAliasesRequest$ResourceId' => 'The identifier of the directory associated with the connection alias.
', 'DescribeTagsRequest$ResourceId' => 'The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
', 'ImageResourceAssociation$AssociatedResourceId' => 'The identifier of the associated resource.
', 'ModifyClientPropertiesRequest$ResourceId' => 'The resource identifiers, in the form of directory IDs.
', 'NetworkAccessConfiguration$EniPrivateIpAddress' => 'The private IP address of the elastic network interface that is attached to instances in your VPC.
', 'NetworkAccessConfiguration$EniId' => 'The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
', 'ResourceIdList$member' => NULL, 'ResourceInUseException$ResourceId' => 'The ID of the resource that is in use.
', 'ResourceNotFoundException$ResourceId' => 'The ID of the resource that could not be found.
', 'ResourceUnavailableException$ResourceId' => 'The identifier of the resource that is not available.
', 'RootStorage$Capacity' => 'The size of the root volume.
', 'SamlProperties$RelayStateParameterName' => 'The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
', 'TagKeyList$member' => NULL, 'UserStorage$Capacity' => 'The size of the user volume.
', 'WorkSpaceApplication$Name' => 'The name of the WorkSpace application.
', 'WorkspaceBundle$Name' => 'The name of the bundle.
', 'WorkspaceResourceAssociation$AssociatedResourceId' => 'The identifier of the associated resource.
', ], ], 'OperatingSystem' => [ 'base' => 'The operating system that the image is running.
', 'refs' => [ 'CreateWorkspaceImageResult$OperatingSystem' => 'The operating system that the image is running.
', 'WorkspaceImage$OperatingSystem' => 'The operating system that the image is running.
', ], ], 'OperatingSystemName' => [ 'base' => NULL, 'refs' => [ 'OperatingSystemNameList$member' => NULL, 'WorkspaceProperties$OperatingSystemName' => 'The name of the operating system.
', ], ], 'OperatingSystemNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$OperatingSystemNames' => 'The operating systems supported by the applications.
', 'WorkSpaceApplication$SupportedOperatingSystemNames' => 'The supported operating systems of the WorkSpace application.
', ], ], 'OperatingSystemNotCompatibleException' => [ 'base' => 'The operating system of the WorkSpace is not compatible with the application.
', 'refs' => [], ], 'OperatingSystemType' => [ 'base' => NULL, 'refs' => [ 'OperatingSystem$Type' => 'The operating system.
', ], ], 'OperationInProgressException' => [ 'base' => 'The properties of this WorkSpace are currently being modified. Try again in a moment.
', 'refs' => [], ], 'OperationNotSupportedException' => [ 'base' => 'This operation is not supported.
', 'refs' => [], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountModificationsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeApplicationAssociationsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeConnectionAliasPermissionsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeConnectionAliasesRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeIpGroupsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspaceBundlesRequest$NextToken' => 'The token for the next set of results. (You received this token from a previous call.)
', 'DescribeWorkspaceBundlesResult$NextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.
', 'DescribeWorkspaceDirectoriesRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspaceImagePermissionsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspaceImagesRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspacesConnectionStatusRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspacesPoolSessionsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'ListAccountLinksRequest$NextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'ListAccountLinksResult$NextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'ListAvailableManagementCidrRangesRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', ], ], 'PendingCreateStandbyWorkspacesRequest' => [ 'base' => 'Information about the standby WorkSpace.
', 'refs' => [ 'PendingCreateStandbyWorkspacesRequestList$member' => NULL, ], ], 'PendingCreateStandbyWorkspacesRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateStandbyWorkspacesResult$PendingStandbyRequests' => 'Information about the standby WorkSpace that was created.
', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'ProtocolList$member' => NULL, ], ], 'ProtocolList' => [ 'base' => NULL, 'refs' => [ 'WorkspaceProperties$Protocols' => 'The protocol. For more information, see Protocols for Amazon WorkSpaces.
Only available for WorkSpaces created with PCoIP bundles.
The Protocols
property is case sensitive. Ensure you use PCOIP
or WSP
.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
Describes the information used to reboot a WorkSpace.
', 'refs' => [ 'RebootWorkspaceRequests$member' => NULL, ], ], 'RebootWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'RebootWorkspacesRequest$RebootWorkspaceRequests' => 'The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
', ], ], 'RebootWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RebootWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'RebuildRequest' => [ 'base' => 'Describes the information used to rebuild a WorkSpace.
', 'refs' => [ 'RebuildWorkspaceRequests$member' => NULL, ], ], 'RebuildWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'RebuildWorkspacesRequest$RebuildWorkspaceRequests' => 'The WorkSpace to rebuild. You can specify a single WorkSpace.
', ], ], 'RebuildWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RebuildWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'ReconnectEnum' => [ 'base' => NULL, 'refs' => [ 'ClientProperties$ReconnectEnabled' => 'Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
', 'SelfservicePermissions$RestartWorkspace' => 'Specifies whether users can restart their WorkSpace.
', 'SelfservicePermissions$IncreaseVolumeSize' => 'Specifies whether users can increase the volume size of the drives on their WorkSpace.
', 'SelfservicePermissions$ChangeComputeType' => 'Specifies whether users can change the compute type (bundle) for their WorkSpace.
', 'SelfservicePermissions$SwitchRunningMode' => 'Specifies whether users can switch the running mode of their WorkSpace.
', 'SelfservicePermissions$RebuildWorkspace' => 'Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$SourceRegion' => 'The identifier of the source Region.
', 'CreateStandbyWorkspacesRequest$PrimaryRegion' => 'The Region of the primary WorkSpace.
', 'RelatedWorkspaceProperties$Region' => 'The Region of the related WorkSpace.
', ], ], 'RegisterWorkspaceDirectoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterWorkspaceDirectoryResult' => [ 'base' => NULL, 'refs' => [], ], 'RegistrationCode' => [ 'base' => NULL, 'refs' => [ 'WorkspaceDirectory$RegistrationCode' => 'The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
', ], ], 'RejectAccountLinkInvitationRequest' => [ 'base' => NULL, 'refs' => [], ], 'RejectAccountLinkInvitationResult' => [ 'base' => NULL, 'refs' => [], ], 'RelatedWorkspaceProperties' => [ 'base' => 'Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
', 'refs' => [ 'RelatedWorkspaces$member' => NULL, ], ], 'RelatedWorkspaces' => [ 'base' => NULL, 'refs' => [ 'Workspace$RelatedWorkspaces' => 'The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
', ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'The specified resource already exists.
', 'refs' => [], ], 'ResourceAssociatedException' => [ 'base' => 'The resource is associated with a directory.
', 'refs' => [], ], 'ResourceCreationFailedException' => [ 'base' => 'The resource could not be created.
', 'refs' => [], ], 'ResourceIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeClientPropertiesRequest$ResourceIds' => 'The resource identifier, in the form of directory IDs.
', ], ], 'ResourceInUseException' => [ 'base' => 'The specified resource is currently in use.
', 'refs' => [], ], 'ResourceLimitExceededException' => [ 'base' => 'Your resource limits have been exceeded.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The resource could not be found.
', 'refs' => [], ], 'ResourceUnavailableException' => [ 'base' => 'The specified resource is not available.
', 'refs' => [], ], 'RestoreWorkspaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreWorkspaceResult' => [ 'base' => NULL, 'refs' => [], ], 'RevokeIpRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeIpRulesResult' => [ 'base' => NULL, 'refs' => [], ], 'RootStorage' => [ 'base' => 'Describes the root volume for a WorkSpace bundle.
', 'refs' => [ 'CreateWorkspaceBundleRequest$RootStorage' => NULL, 'WorkspaceBundle$RootStorage' => 'The size of the root volume.
', ], ], 'RootVolumeSizeGib' => [ 'base' => NULL, 'refs' => [ 'WorkspaceProperties$RootVolumeSizeGib' => 'The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
', ], ], 'RunningMode' => [ 'base' => NULL, 'refs' => [ 'WorkspaceProperties$RunningMode' => 'The running mode. For more information, see Manage the WorkSpace Running Mode.
The MANUAL
value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'ApplicationSettingsResponse$S3BucketName' => 'The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.
', ], ], 'SamlProperties' => [ 'base' => 'Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
', 'refs' => [ 'ModifySamlPropertiesRequest$SamlProperties' => 'The properties for configuring SAML 2.0 authentication.
', 'WorkspaceDirectory$SamlProperties' => 'Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
', ], ], 'SamlStatusEnum' => [ 'base' => NULL, 'refs' => [ 'SamlProperties$Status' => 'Indicates the status of SAML 2.0 authentication. These statuses include the following.
If the setting is DISABLED
, end users will be directed to login with their directory credentials.
If the setting is ENABLED
, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
', ], ], 'SecretsManagerArn' => [ 'base' => NULL, 'refs' => [ 'ActiveDirectoryConfig$ServiceAccountSecretArn' => 'Indicates the secret ARN on the service account.
', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'DefaultWorkspaceCreationProperties$CustomSecurityGroupId' => 'The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
', 'WorkspaceCreationProperties$CustomSecurityGroupId' => 'The identifier of your custom security group.
', 'WorkspaceDirectory$WorkspaceSecurityGroupId' => 'The identifier of the security group that is assigned to new WorkSpaces.
', ], ], 'SelfservicePermissions' => [ 'base' => 'Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
', 'refs' => [ 'ModifySelfservicePermissionsRequest$SelfservicePermissions' => 'The permissions to enable or disable self-service capabilities.
', 'WorkspaceDirectory$SelfservicePermissions' => 'The default self-service permissions for WorkSpaces in the directory.
', ], ], 'SessionConnectionState' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolSession$ConnectionState' => 'Specifies whether a user is connected to the pool session.
', ], ], 'SessionInstanceId' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolSession$InstanceId' => 'The identifier for the instance hosting the session.
', ], ], 'SettingsGroup' => [ 'base' => NULL, 'refs' => [ 'ApplicationSettingsRequest$SettingsGroup' => 'The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.
', 'ApplicationSettingsResponse$SettingsGroup' => 'The path prefix for the S3 bucket where users’ persistent application settings are stored.
', ], ], 'Snapshot' => [ 'base' => 'Describes a snapshot.
', 'refs' => [ 'SnapshotList$member' => NULL, ], ], 'SnapshotList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceSnapshotsResult$RebuildSnapshots' => 'Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
', 'DescribeWorkspaceSnapshotsResult$RestoreSnapshots' => 'Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
', ], ], 'StandbyWorkspace' => [ 'base' => 'Describes a standby WorkSpace.
', 'refs' => [ 'FailedCreateStandbyWorkspacesRequest$StandbyWorkspaceRequest' => 'Information about the standby WorkSpace that could not be created.
', 'StandbyWorkspacesList$member' => NULL, ], ], 'StandbyWorkspaceRelationshipType' => [ 'base' => NULL, 'refs' => [ 'RelatedWorkspaceProperties$Type' => 'Indicates the type of WorkSpace.
', ], ], 'StandbyWorkspacesList' => [ 'base' => NULL, 'refs' => [ 'CreateStandbyWorkspacesRequest$StandbyWorkspaces' => 'Information about the standby WorkSpace to be created.
', ], ], 'StandbyWorkspacesProperties' => [ 'base' => 'Describes the properties of the related standby WorkSpaces.
', 'refs' => [ 'StandbyWorkspacesPropertiesList$member' => NULL, ], ], 'StandbyWorkspacesPropertiesList' => [ 'base' => NULL, 'refs' => [ 'Workspace$StandbyWorkspacesProperties' => 'The properties of the standby WorkSpace
', ], ], 'StartRequest' => [ 'base' => 'Information used to start a WorkSpace.
', 'refs' => [ 'StartWorkspaceRequests$member' => NULL, ], ], 'StartWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'StartWorkspacesRequest$StartWorkspaceRequests' => 'The WorkSpaces to start. You can specify up to 25 WorkSpaces.
', ], ], 'StartWorkspacesPoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkspacesPoolResult' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'StopRequest' => [ 'base' => 'Describes the information used to stop a WorkSpace.
', 'refs' => [ 'StopWorkspaceRequests$member' => NULL, ], ], 'StopWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'StopWorkspacesRequest$StopWorkspaceRequests' => 'The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
', ], ], 'StopWorkspacesPoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkspacesPoolResult' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'StorageConnector' => [ 'base' => 'Describes the storage connector.
', 'refs' => [ 'StorageConnectors$member' => NULL, ], ], 'StorageConnectorStatusEnum' => [ 'base' => NULL, 'refs' => [ 'StorageConnector$Status' => 'Indicates if the storage connetor is enabled or disabled.
', ], ], 'StorageConnectorTypeEnum' => [ 'base' => NULL, 'refs' => [ 'StorageConnector$ConnectorType' => 'The type of connector used to save user files.
', ], ], 'StorageConnectors' => [ 'base' => NULL, 'refs' => [ 'StreamingProperties$StorageConnectors' => 'Indicates the storage connector used
', ], ], 'StreamingExperiencePreferredProtocolEnum' => [ 'base' => NULL, 'refs' => [ 'StreamingProperties$StreamingExperiencePreferredProtocol' => 'Indicates the type of preferred protocol for the streaming experience.
', ], ], 'StreamingProperties' => [ 'base' => 'Describes the streaming properties.
', 'refs' => [ 'ModifyStreamingPropertiesRequest$StreamingProperties' => 'The streaming properties to configure.
', 'WorkspaceDirectory$StreamingProperties' => 'The streaming properties to configure.
', ], ], 'String2048' => [ 'base' => NULL, 'refs' => [ 'AssociationStateReason$ErrorMessage' => 'The error message of the association deployment failure.
', 'WorkSpaceApplication$Description' => 'The description of the WorkSpace application.
', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, 'Workspace$SubnetId' => 'The identifier of the subnet for the WorkSpace.
', ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$SubnetIds' => 'The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
', 'WorkspaceDirectory$SubnetIds' => 'The identifiers of the subnets used with the directory.
', ], ], 'Tag' => [ 'base' => 'Describes a tag.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key of the tag.
', ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'DeleteTagsRequest$TagKeys' => 'The tag keys.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$Tags' => 'The tags for the image.
', 'CreateConnectionAliasRequest$Tags' => 'The tags to associate with the connection alias.
', 'CreateIpGroupRequest$Tags' => 'The tags. Each WorkSpaces resource can have a maximum of 50 tags.
', 'CreateTagsRequest$Tags' => 'The tags. Each WorkSpaces resource can have a maximum of 50 tags.
', 'CreateUpdatedWorkspaceImageRequest$Tags' => 'The tags that you want to add to the new updated WorkSpace image.
To add tags at the same time when you\'re creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags
.
The tags associated with the bundle.
To add tags at the same time when you\'re creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags
.
The tags that you want to add to the new WorkSpace image. To add tags when you\'re creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags
.
The tags for the WorkSpaces pool.
', 'DescribeTagsResult$TagList' => 'The tags.
', 'ImportWorkspaceImageRequest$Tags' => 'The tags. Each WorkSpaces resource can have a maximum of 50 tags.
', 'RegisterWorkspaceDirectoryRequest$Tags' => 'The tags associated with the directory.
', 'StandbyWorkspace$Tags' => 'The tags associated with the standby WorkSpace.
', 'WorkspaceRequest$Tags' => 'The tags for the WorkSpace.
', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value of the tag.
', ], ], 'TargetWorkspaceState' => [ 'base' => NULL, 'refs' => [ 'ModifyWorkspaceStateRequest$WorkspaceState' => 'The WorkSpace state.
', ], ], 'Tenancy' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$Tenancy' => 'Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED
and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED
. For more information, see Bring Your Own Windows Desktop Images.
Describes the information used to terminate a WorkSpace.
', 'refs' => [ 'TerminateWorkspaceRequests$member' => NULL, ], ], 'TerminateWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'TerminateWorkspacesRequest$TerminateWorkspaceRequests' => 'The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
', ], ], 'TerminateWorkspacesPoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesPoolResult' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesPoolSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesPoolSessionResult' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'TimeoutSettings' => [ 'base' => 'Describes the timeout settings for a WorkSpaces pool.
', 'refs' => [ 'CreateWorkspacesPoolRequest$TimeoutSettings' => 'Indicates the timeout settings of the WorkSpaces pool.
', 'UpdateWorkspacesPoolRequest$TimeoutSettings' => 'Indicates the timeout settings of the specified WorkSpaces pool.
', 'WorkspacesPool$TimeoutSettings' => 'The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AccountModification$StartTime' => 'The timestamp when the modification of the BYOL configuration was started.
', 'ApplicationResourceAssociation$Created' => 'The time the association was created.
', 'ApplicationResourceAssociation$LastUpdatedTime' => 'The time the association status was last updated.
', 'BundleResourceAssociation$Created' => 'The time the association is created.
', 'BundleResourceAssociation$LastUpdatedTime' => 'The time the association status was last updated.
', 'CreateWorkspaceImageResult$Created' => 'The date when the image was created.
', 'DataReplicationSettings$RecoverySnapshotTime' => 'The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
', 'ImageResourceAssociation$Created' => 'The time the association is created.
', 'ImageResourceAssociation$LastUpdatedTime' => 'The time the association status was last updated.
', 'Snapshot$SnapshotTime' => 'The time when the snapshot was created.
', 'StandbyWorkspacesProperties$RecoverySnapshotTime' => 'The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
', 'WorkSpaceApplication$Created' => 'The time the application is created.
', 'WorkspaceBundle$LastUpdatedTime' => 'The last time that the bundle was updated.
', 'WorkspaceBundle$CreationTime' => 'The time when the bundle was created.
', 'WorkspaceConnectionStatus$ConnectionStateCheckTimestamp' => 'The timestamp of the connection status check.
', 'WorkspaceConnectionStatus$LastKnownUserConnectionTimestamp' => 'The timestamp of the last known user connection.
', 'WorkspaceImage$Created' => 'The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
', 'WorkspaceResourceAssociation$Created' => 'The time the association is created.
', 'WorkspaceResourceAssociation$LastUpdatedTime' => 'The time the association status was last updated.
', 'WorkspacesPool$CreatedAt' => 'The time the pool was created.
', 'WorkspacesPoolSession$ExpirationTime' => 'The time that the pool session ended.
', 'WorkspacesPoolSession$StartTime' => 'The time that the pool sission started.
', ], ], 'UnsupportedNetworkConfigurationException' => [ 'base' => 'The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
', 'refs' => [], ], 'UnsupportedWorkspaceConfigurationException' => [ 'base' => 'The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
', 'refs' => [], ], 'UpdateConnectClientAddInRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectClientAddInResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionAliasPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionAliasPermissionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDescription' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesPoolRequest$Description' => 'The WorkSpaces pool description.
', 'UpdateResult$Description' => 'A description of whether updates for the WorkSpace image are pending or available.
', 'UpdateWorkspacesPoolRequest$Description' => 'Describes the specified WorkSpaces pool to update.
', 'WorkspacesPool$Description' => 'The description of the pool.
', ], ], 'UpdateResult' => [ 'base' => 'Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.
Only Windows 10 WorkSpace images can be programmatically updated at this time.
The updates (if any) that are available for the specified image.
', ], ], 'UpdateRulesOfIpGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRulesOfIpGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspaceBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspaceBundleResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspaceImagePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspaceImagePermissionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspacesPoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspacesPoolResult' => [ 'base' => NULL, 'refs' => [], ], 'UserIdentityType' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$UserIdentityType' => 'The type of identity management the user is using.
', 'WorkspaceDirectory$UserIdentityType' => 'Indicates the identity type of the specifired user.
', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesRequest$UserName' => 'The name of the directory user. You must specify this parameter with DirectoryId
.
Describes the standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
', 'Workspace$UserName' => 'The user for the WorkSpace.
', 'WorkspaceDirectory$CustomerUserName' => 'The user name for the service account.
', 'WorkspaceRequest$UserName' => 'The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The reserved keyword, [UNDEFINED]
, is used when creating user-decoupled WorkSpaces.
Information about the user\'s permission settings.
', 'refs' => [ 'UserSettings$member' => NULL, ], ], 'UserSettingActionEnum' => [ 'base' => NULL, 'refs' => [ 'UserSetting$Action' => 'Indicates the type of action.
', ], ], 'UserSettingPermissionEnum' => [ 'base' => NULL, 'refs' => [ 'UserSetting$Permission' => 'Indicates if the setting is enabled or disabled.
', ], ], 'UserSettings' => [ 'base' => NULL, 'refs' => [ 'StreamingProperties$UserSettings' => 'Indicates the permission settings asscoiated with the user.
', ], ], 'UserStorage' => [ 'base' => 'Describes the user volume for a WorkSpace bundle.
', 'refs' => [ 'CreateWorkspaceBundleRequest$UserStorage' => NULL, 'WorkspaceBundle$UserStorage' => 'The size of the user volume.
', ], ], 'UserVolumeSizeGib' => [ 'base' => NULL, 'refs' => [ 'WorkspaceProperties$UserVolumeSizeGib' => 'The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
', ], ], 'ValidationException' => [ 'base' => 'You either haven\'t provided a TargetAccountId
or are using the same value for TargetAccountId
and SourceAccountId
.
The volume encryption key of the standby WorkSpace.
', 'Workspace$VolumeEncryptionKey' => 'The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
', 'WorkspaceRequest$VolumeEncryptionKey' => 'The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
', ], ], 'WorkSpaceApplication' => [ 'base' => 'Describes the WorkSpace application.
', 'refs' => [ 'WorkSpaceApplicationList$member' => NULL, ], ], 'WorkSpaceApplicationDeployment' => [ 'base' => 'Describes the WorkSpace application deployment.
', 'refs' => [ 'DeployWorkspaceApplicationsResult$Deployment' => 'The list of deployed associations and information about them.
', ], ], 'WorkSpaceApplicationId' => [ 'base' => NULL, 'refs' => [ 'ApplicationResourceAssociation$ApplicationId' => 'The identifier of the application.
', 'AssociateWorkspaceApplicationRequest$ApplicationId' => 'The identifier of the application.
', 'DescribeApplicationAssociationsRequest$ApplicationId' => 'The identifier of the specified application.
', 'DisassociateWorkspaceApplicationRequest$ApplicationId' => 'The identifier of the application.
', 'WorkSpaceApplication$ApplicationId' => 'The identifier of the application.
', 'WorkSpaceApplicationIdList$member' => NULL, ], ], 'WorkSpaceApplicationIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$ApplicationIds' => 'The identifiers of one or more applications.
', ], ], 'WorkSpaceApplicationLicenseType' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$LicenseType' => 'The license availability for the applications.
', 'WorkSpaceApplication$LicenseType' => 'The license availability for the applications.
', ], ], 'WorkSpaceApplicationList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsResult$Applications' => 'List of information about the specified applications.
', ], ], 'WorkSpaceApplicationOwner' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$Owner' => 'The owner of the applications.
', 'WorkSpaceApplication$Owner' => 'The owner of the WorkSpace application.
', ], ], 'WorkSpaceApplicationState' => [ 'base' => NULL, 'refs' => [ 'WorkSpaceApplication$State' => 'The status of WorkSpace application.
', ], ], 'WorkSpaceAssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'WorkSpaceAssociatedResourceTypeList$member' => NULL, 'WorkspaceResourceAssociation$AssociatedResourceType' => 'The resource types of the associated resource.
', ], ], 'WorkSpaceAssociatedResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceAssociationsRequest$AssociatedResourceTypes' => 'The resource types of the associated resources.
', ], ], 'Workspace' => [ 'base' => 'Describes a WorkSpace.
', 'refs' => [ 'WorkspaceList$member' => NULL, ], ], 'WorkspaceAccessProperties' => [ 'base' => 'The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.
', 'refs' => [ 'ModifyWorkspaceAccessPropertiesRequest$WorkspaceAccessProperties' => 'The device types and operating systems to enable or disable for access.
', 'WorkspaceDirectory$WorkspaceAccessProperties' => 'The devices and operating systems that users can use to access WorkSpaces.
', ], ], 'WorkspaceBundle' => [ 'base' => 'Describes a WorkSpace bundle.
', 'refs' => [ 'BundleList$member' => NULL, 'CreateWorkspaceBundleResult$WorkspaceBundle' => NULL, ], ], 'WorkspaceBundleDescription' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspaceBundleRequest$BundleDescription' => 'The description of the bundle.
', ], ], 'WorkspaceBundleName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspaceBundleRequest$BundleName' => 'The name of the bundle.
', ], ], 'WorkspaceBundleState' => [ 'base' => NULL, 'refs' => [ 'WorkspaceBundle$State' => 'The state of the WorkSpace bundle.
', ], ], 'WorkspaceConnectionStatus' => [ 'base' => 'Describes the connection status of a WorkSpace.
', 'refs' => [ 'WorkspaceConnectionStatusList$member' => NULL, ], ], 'WorkspaceConnectionStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesConnectionStatusResult$WorkspacesConnectionStatus' => 'Information about the connection status of the WorkSpace.
', ], ], 'WorkspaceCreationProperties' => [ 'base' => 'Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
', 'refs' => [ 'ModifyWorkspaceCreationPropertiesRequest$WorkspaceCreationProperties' => 'The default properties for creating WorkSpaces.
', ], ], 'WorkspaceDirectory' => [ 'base' => 'Describes a directory that is used with Amazon WorkSpaces.
', 'refs' => [ 'DirectoryList$member' => NULL, ], ], 'WorkspaceDirectoryDescription' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$WorkspaceDirectoryDescription' => 'Description of the directory to register.
', 'WorkspaceDirectory$WorkspaceDirectoryDescription' => 'The description of the WorkSpace directory
', ], ], 'WorkspaceDirectoryName' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$WorkspaceDirectoryName' => 'The name of the directory to register.
', 'WorkspaceDirectory$WorkspaceDirectoryName' => 'The name fo the WorkSpace directory.
', 'WorkspaceDirectoryNameList$member' => NULL, ], ], 'WorkspaceDirectoryNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceDirectoriesRequest$WorkspaceDirectoryNames' => 'The names of the WorkSpace directories.
', ], ], 'WorkspaceDirectoryState' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryResult$State' => 'The registration status of the WorkSpace directory.
', 'WorkspaceDirectory$State' => 'The state of the directory\'s registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED
state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn\'t returned, then the directory has been successfully deregistered.
The directory type.
', ], ], 'WorkspaceErrorCode' => [ 'base' => NULL, 'refs' => [ 'AccountModification$ErrorCode' => 'The error code that is returned if the configuration of BYOL cannot be modified.
', 'FailedCreateStandbyWorkspacesRequest$ErrorCode' => 'The error code that is returned if the standby WorkSpace could not be created.
', 'Workspace$ErrorCode' => 'The error code that is returned if the WorkSpace cannot be created.
', ], ], 'WorkspaceId' => [ 'base' => NULL, 'refs' => [ 'AssociateWorkspaceApplicationRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'CreateWorkspaceImageRequest$WorkspaceId' => 'The identifier of the source WorkSpace
', 'DeployWorkspaceApplicationsRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'DescribeWorkspaceAssociationsRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'DescribeWorkspaceSnapshotsRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'DisassociateWorkspaceApplicationRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'FailedWorkspaceChangeRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'MigrateWorkspaceRequest$SourceWorkspaceId' => 'The identifier of the WorkSpace to migrate from.
', 'MigrateWorkspaceResult$SourceWorkspaceId' => 'The original identifier of the WorkSpace that is being migrated.
', 'MigrateWorkspaceResult$TargetWorkspaceId' => 'The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
', 'ModifyWorkspacePropertiesRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'ModifyWorkspaceStateRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'PendingCreateStandbyWorkspacesRequest$WorkspaceId' => 'The identifier of the standby WorkSpace.
', 'RebootRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'RebuildRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'RelatedWorkspaceProperties$WorkspaceId' => 'The identifier of the related WorkSpace.
', 'RestoreWorkspaceRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'StandbyWorkspace$PrimaryWorkspaceId' => 'The identifier of the standby WorkSpace.
', 'StandbyWorkspacesProperties$StandbyWorkspaceId' => 'The identifier of the standby WorkSpace
', 'StartRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'StopRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'TerminateRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'Workspace$WorkspaceId' => 'The identifier of the WorkSpace.
', 'WorkspaceConnectionStatus$WorkspaceId' => 'The identifier of the WorkSpace.
', 'WorkspaceIdList$member' => NULL, 'WorkspaceResourceAssociation$WorkspaceId' => 'The identifier of the WorkSpace.
', ], ], 'WorkspaceIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesConnectionStatusRequest$WorkspaceIds' => 'The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
', 'DescribeWorkspacesRequest$WorkspaceIds' => 'The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
', ], ], 'WorkspaceImage' => [ 'base' => 'Describes a WorkSpace image.
', 'refs' => [ 'WorkspaceImageList$member' => NULL, ], ], 'WorkspaceImageDescription' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$Description' => 'A description of the image.
', 'CreateUpdatedWorkspaceImageRequest$Description' => 'A description of whether updates for the WorkSpace image are available.
', 'CreateWorkspaceImageRequest$Description' => 'The description of the new WorkSpace image.
', 'CreateWorkspaceImageResult$Description' => 'The description of the image.
', 'ImportWorkspaceImageRequest$ImageDescription' => 'The description of the WorkSpace image.
', 'WorkspaceImage$Description' => 'The description of the image.
', ], ], 'WorkspaceImageErrorCode' => [ 'base' => NULL, 'refs' => [ 'WorkspaceImage$ErrorCode' => 'The error code that is returned for the image.
', ], ], 'WorkspaceImageErrorDetailCode' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorCode' => 'Indicates the error code returned.
', ], ], 'WorkspaceImageId' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$SourceImageId' => 'The identifier of the source image.
', 'CopyWorkspaceImageResult$ImageId' => 'The identifier of the image.
', 'CreateUpdatedWorkspaceImageRequest$SourceImageId' => 'The identifier of the source WorkSpace image.
', 'CreateUpdatedWorkspaceImageResult$ImageId' => 'The identifier of the new updated WorkSpace image.
', 'CreateWorkspaceBundleRequest$ImageId' => 'The identifier of the image that is used to create the bundle.
', 'CreateWorkspaceImageResult$ImageId' => 'The identifier of the new WorkSpace image.
', 'DeleteWorkspaceImageRequest$ImageId' => 'The identifier of the image.
', 'DescribeImageAssociationsRequest$ImageId' => 'The identifier of the image.
', 'DescribeWorkspaceImagePermissionsRequest$ImageId' => 'The identifier of the image.
', 'DescribeWorkspaceImagePermissionsResult$ImageId' => 'The identifier of the image.
', 'ImageResourceAssociation$ImageId' => 'The identifier of the image.
', 'ImportWorkspaceImageResult$ImageId' => 'The identifier of the WorkSpace image.
', 'UpdateWorkspaceBundleRequest$ImageId' => 'The identifier of the image.
', 'UpdateWorkspaceImagePermissionRequest$ImageId' => 'The identifier of the image.
', 'WorkspaceBundle$ImageId' => 'The identifier of the image that was used to create the bundle.
', 'WorkspaceImage$ImageId' => 'The identifier of the image.
', 'WorkspaceImageIdList$member' => NULL, ], ], 'WorkspaceImageIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceImagesRequest$ImageIds' => 'The identifier of the image.
', ], ], 'WorkspaceImageIngestionProcess' => [ 'base' => NULL, 'refs' => [ 'ImportWorkspaceImageRequest$IngestionProcess' => 'The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP
. To use PCoIP, specify a value that does not end in _WSP
. To use BYOP, specify a value that ends in _BYOP
.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR
, BYOL_REGULAR_WSP
, or BYOL_REGULAR_BYOP
, depending on the protocol.
The BYOL_REGULAR_BYOP
and BYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
Information about the images.
', ], ], 'WorkspaceImageName' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$Name' => 'The name of the image.
', 'CreateUpdatedWorkspaceImageRequest$Name' => 'The name of the new updated WorkSpace image.
', 'CreateWorkspaceImageRequest$Name' => 'The name of the new WorkSpace image.
', 'CreateWorkspaceImageResult$Name' => 'The name of the image.
', 'ImportWorkspaceImageRequest$ImageName' => 'The name of the WorkSpace image.
', 'WorkspaceImage$Name' => 'The name of the image.
', ], ], 'WorkspaceImageRequiredTenancy' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspaceImageResult$RequiredTenancy' => 'Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
', 'WorkspaceImage$RequiredTenancy' => 'Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED
. For more information, see Bring Your Own Windows Desktop Images.
The availability status of the image.
', 'WorkspaceImage$State' => 'The status of the image.
', ], ], 'WorkspaceList' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesResult$PendingRequests' => 'Information about the WorkSpaces that were created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
', 'DescribeWorkspacesResult$Workspaces' => 'Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
', ], ], 'WorkspaceName' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesRequest$WorkspaceName' => 'The name of the user-decoupled WorkSpace.
', 'Workspace$WorkspaceName' => 'The name of the user-decoupled WorkSpace.
', 'WorkspaceRequest$WorkspaceName' => 'The name of the user-decoupled WorkSpace.
', ], ], 'WorkspaceProperties' => [ 'base' => 'Describes a WorkSpace.
', 'refs' => [ 'ModifyWorkspacePropertiesRequest$WorkspaceProperties' => 'The properties of the WorkSpace.
', 'Workspace$WorkspaceProperties' => 'The properties of the WorkSpace.
', 'WorkspaceRequest$WorkspaceProperties' => 'The WorkSpace properties.
', ], ], 'WorkspaceRequest' => [ 'base' => 'Describes the information used to create a WorkSpace.
', 'refs' => [ 'FailedCreateWorkspaceRequest$WorkspaceRequest' => 'Information about the WorkSpace.
', 'WorkspaceRequestList$member' => NULL, ], ], 'WorkspaceRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesRequest$Workspaces' => 'The WorkSpaces to create. You can specify up to 25 WorkSpaces.
', ], ], 'WorkspaceResourceAssociation' => [ 'base' => 'Describes the association between an application and a WorkSpace resource.
', 'refs' => [ 'AssociateWorkspaceApplicationResult$Association' => 'Information about the association between the specified WorkSpace and the specified application.
', 'DisassociateWorkspaceApplicationResult$Association' => 'Information about the targeted association.
', 'WorkspaceResourceAssociationList$member' => NULL, ], ], 'WorkspaceResourceAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceAssociationsResult$Associations' => 'List of information about the specified associations.
', 'WorkSpaceApplicationDeployment$Associations' => 'The associations between the applications and the associated resources.
', ], ], 'WorkspaceState' => [ 'base' => NULL, 'refs' => [ 'PendingCreateStandbyWorkspacesRequest$State' => 'The operational state of the standby WorkSpace.
', 'RelatedWorkspaceProperties$State' => 'Indicates the state of the WorkSpace.
', 'Workspace$State' => 'The operational state of the WorkSpace.
PENDING
– The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
AVAILABLE
– The WorkSpace is running and has passed the health checks.
IMPAIRED
– Refer to UNHEALTHY
state.
UNHEALTHY
– The WorkSpace is not responding to health checks.
REBOOTING
– The WorkSpace is being rebooted (restarted).
STARTING
– The WorkSpace is starting up and health checks are being run.
REBUILDING
– The WorkSpace is being rebuilt.
RESTORING
– The WorkSpace is being restored.
MAINTENANCE
– The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
ADMIN_MAINTENANCE
– The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
TERMINATING
– The WorkSpace is being deleted.
TERMINATED
– The WorkSpace has been deleted.
SUSPENDED
– The WorkSpace has been suspended for image creation.
UPDATING
– The WorkSpace is undergoing an update.
STOPPING
– The WorkSpace is being stopped.
STOPPED
– The WorkSpace has been stopped.
ERROR
– The WorkSpace is an error state (for example, an error occurred during startup).
After a WorkSpace is terminated, the TERMINATED
state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn\'t returned, then the WorkSpace has been successfully terminated.
Indicates whether the directory\'s WorkSpace type is personal or pools.
', 'WorkspaceDirectory$WorkspaceType' => 'Indicates whether the directory\'s WorkSpace type is personal or pools.
', ], ], 'WorkspacesDefaultRoleNotFoundException' => [ 'base' => 'The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
', 'refs' => [], ], 'WorkspacesIpGroup' => [ 'base' => 'Describes an IP access control group.
', 'refs' => [ 'WorkspacesIpGroupsList$member' => NULL, ], ], 'WorkspacesIpGroupsList' => [ 'base' => NULL, 'refs' => [ 'DescribeIpGroupsResult$Result' => 'Information about the IP access control groups.
', ], ], 'WorkspacesPool' => [ 'base' => 'Describes a WorkSpaces pool.
', 'refs' => [ 'CreateWorkspacesPoolResult$WorkspacesPool' => 'Indicates the WorkSpaces pool to create.
', 'UpdateWorkspacesPoolResult$WorkspacesPool' => 'Describes the specified WorkSpaces pool.
', 'WorkspacesPools$member' => NULL, ], ], 'WorkspacesPoolError' => [ 'base' => 'Describes a WorkSpaces pool error.
', 'refs' => [ 'WorkspacesPoolErrors$member' => NULL, ], ], 'WorkspacesPoolErrorCode' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolError$ErrorCode' => 'The error code.
', ], ], 'WorkspacesPoolErrors' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPool$Errors' => 'The pool errors.
', ], ], 'WorkspacesPoolId' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolSessionsRequest$PoolId' => 'The identifier of the WorkSpaces pool.
', 'StartWorkspacesPoolRequest$PoolId' => 'The identifier of the WorkSpaces pool.
', 'StopWorkspacesPoolRequest$PoolId' => 'The identifier of the WorkSpaces pool.
', 'TerminateWorkspacesPoolRequest$PoolId' => 'The identifier of the WorkSpaces pool.
', 'UpdateWorkspacesPoolRequest$PoolId' => 'The identifier of the specified WorkSpaces pool to update.
', 'WorkspacesPool$PoolId' => 'The identifier of a WorkSpaces pool.
', 'WorkspacesPoolIds$member' => NULL, 'WorkspacesPoolSession$PoolId' => 'The identifier of the pool.
', ], ], 'WorkspacesPoolIds' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsRequest$PoolIds' => 'The identifier of the WorkSpaces pool.
', ], ], 'WorkspacesPoolName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesPoolRequest$PoolName' => 'The name of the WorkSpaces pool.
', 'WorkspacesPool$PoolName' => 'The name of the pool,
', ], ], 'WorkspacesPoolSession' => [ 'base' => 'Describes a WorkSpaces pool session.
', 'refs' => [ 'WorkspacesPoolSessions$member' => NULL, ], ], 'WorkspacesPoolSessions' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolSessionsResult$Sessions' => 'Describes the WorkSpaces pool sessions.
', ], ], 'WorkspacesPoolState' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPool$State' => 'The current state of the pool.
', ], ], 'WorkspacesPoolUserId' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolSessionsRequest$UserId' => 'The identifier of the user.
', 'WorkspacesPoolSession$UserId' => 'The identifier of the user.
', ], ], 'WorkspacesPools' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsResult$WorkspacesPools' => 'Information about the WorkSpaces pools.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.
You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.
', 'operations' => [ 'AcceptAccountLinkInvitation' => 'Accepts the account link invitation.
There\'s currently no unlinking capability after you accept the account linking invitation.
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
Associates the specified IP access control group with the specified directory.
', 'AssociateWorkspaceApplication' => 'Associates the specified application to the specified WorkSpace.
', 'AuthorizeIpRules' => 'Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
', 'CopyWorkspaceImage' => 'Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
Creates the account link invitation.
', 'CreateConnectClientAddIn' => 'Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
', 'CreateConnectionAlias' => 'Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'CreateIpGroup' => 'Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don\'t associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
', 'CreateStandbyWorkspaces' => 'Creates a standby WorkSpace in a secondary Region.
', 'CreateTags' => 'Creates the specified tags for the specified WorkSpaces resource.
', 'CreateUpdatedWorkspaceImage' => 'Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
Microsoft Windows updates and other application updates are not included in the update process.
The source WorkSpace image is not deleted. You can delete the source image after you\'ve verified your new updated image and created a new bundle.
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
', 'CreateWorkspaceImage' => 'Creates a new WorkSpace image from an existing WorkSpace.
', 'CreateWorkspaces' => 'Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
The MANUAL
running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
You don\'t need to specify the PCOIP
protocol for Linux bundles because WSP
is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
Creates a pool of WorkSpaces.
', 'DeleteAccountLinkInvitation' => 'Deletes the account link invitation.
', 'DeleteClientBranding' => 'Deletes customized client branding. Client branding allows you to customize your WorkSpace\'s client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you delete your customized client branding, your login portal reverts to the default client branding.
', 'DeleteConnectClientAddIn' => 'Deletes a client-add-in for Amazon Connect that is configured within a directory.
', 'DeleteConnectionAlias' => 'Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
', 'DeleteTags' => 'Deletes the specified tags from the specified WorkSpaces resource.
', 'DeleteWorkspaceBundle' => 'Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
', 'DeleteWorkspaceImage' => 'Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
', 'DeployWorkspaceApplications' => 'Deploys associated applications to the specified WorkSpace
', 'DeregisterWorkspaceDirectory' => 'Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
', 'DescribeAccountModifications' => 'Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
', 'DescribeApplicationAssociations' => 'Describes the associations between the application and the specified associated resources.
', 'DescribeApplications' => 'Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
', 'DescribeBundleAssociations' => 'Describes the associations between the applications and the specified bundle.
', 'DescribeClientBranding' => 'Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
Only device types that have branding information configured will be shown in the response.
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
', 'DescribeConnectClientAddIns' => 'Retrieves a list of Amazon Connect client add-ins that have been created.
', 'DescribeConnectionAliasPermissions' => 'Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'DescribeConnectionAliases' => 'Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'DescribeImageAssociations' => 'Describes the associations between the applications and the specified image.
', 'DescribeIpGroups' => 'Describes one or more of your IP access control groups.
', 'DescribeTags' => 'Describes the specified tags for the specified WorkSpaces resource.
', 'DescribeWorkspaceAssociations' => 'Describes the associations betweens applications and the specified WorkSpace.
', 'DescribeWorkspaceBundles' => 'Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
', 'DescribeWorkspaceDirectories' => 'Describes the available directories that are registered with Amazon WorkSpaces.
', 'DescribeWorkspaceImagePermissions' => 'Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
', 'DescribeWorkspaceImages' => 'Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
', 'DescribeWorkspaceSnapshots' => 'Describes the snapshots for the specified WorkSpace.
', 'DescribeWorkspaces' => 'Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
', 'DescribeWorkspacesConnectionStatus' => 'Describes the connection status of the specified WorkSpaces.
', 'DescribeWorkspacesPoolSessions' => 'Retrieves a list that describes the streaming sessions for a specified pool.
', 'DescribeWorkspacesPools' => 'Describes the specified WorkSpaces Pools.
', 'DisassociateConnectionAlias' => 'Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
Disassociates the specified IP access control group from the specified directory.
', 'DisassociateWorkspaceApplication' => 'Disassociates the specified application from a WorkSpace.
', 'GetAccountLink' => 'Retrieves account link information.
', 'ImportClientBranding' => 'Imports client branding. Client branding allows you to customize your WorkSpace\'s client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
You must specify at least one platform type when importing client branding.
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
Imported data can take up to a minute to appear in the WorkSpaces client.
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
', 'ListAccountLinks' => 'Lists all account links.
', 'ListAvailableManagementCidrRanges' => 'Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn\'t enabled for BYOL, you\'ll receive an AccessDeniedException
error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
', 'MigrateWorkspace' => 'Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\\Users\\%USERNAME%
user profile folder is renamed to D:\\Users\\%USERNAME%MMddyyTHHmmss%.NotMigrated
. A new D:\\Users\\%USERNAME%\\
folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
', 'ModifyAccount' => 'Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
', 'ModifyCertificateBasedAuthProperties' => 'Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
', 'ModifyClientProperties' => 'Modifies the properties of the specified Amazon WorkSpaces clients.
', 'ModifySamlProperties' => 'Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
', 'ModifySelfservicePermissions' => 'Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
', 'ModifyStreamingProperties' => 'Modifies the specified streaming properties.
', 'ModifyWorkspaceAccessProperties' => 'Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
', 'ModifyWorkspaceCreationProperties' => 'Modify the default properties used to create WorkSpaces.
', 'ModifyWorkspaceProperties' => 'Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The MANUAL
running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE
. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE
state.
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE
, UNHEALTHY
, or REBOOTING
. Reboot a WorkSpace in the REBOOTING
state only if your WorkSpace has been stuck in the REBOOTING
state for over 20 minutes.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
', 'RebuildWorkspaces' => 'Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
, UNHEALTHY
, STOPPED
, or REBOOTING
.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
', 'RegisterWorkspaceDirectory' => 'Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
', 'RejectAccountLinkInvitation' => 'Rejects the account link invitation.
', 'RestoreWorkspace' => 'Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE
, ERROR
, UNHEALTHY
, or STOPPED
.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
', 'RevokeIpRules' => 'Removes one or more rules from the specified IP access control group.
', 'StartWorkspaces' => 'Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop
and a state of STOPPED
.
Starts the specified pool.
You cannot start a pool unless it has a running mode of AutoStop
and a state of STOPPED
.
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
Stops the specified pool.
You cannot stop a WorkSpace pool unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user\'s data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED
.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED
state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn\'t returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Terminates the specified pool.
', 'TerminateWorkspacesPoolSession' => 'Terminates the pool session.
', 'UpdateConnectClientAddIn' => 'Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
', 'UpdateConnectionAliasPermission' => 'Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
Replaces the current rules of the specified IP access control group with the specified rules.
', 'UpdateWorkspaceBundle' => 'Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren\'t automatically updated when you update the bundle that they\'re based on. To update existing WorkSpaces that are based on a bundle that you\'ve updated, you must either rebuild the WorkSpaces or delete and recreate them.
Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn\'t supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.
Updates the specified pool.
', ], 'shapes' => [ 'ARN' => [ 'base' => NULL, 'refs' => [ 'DefaultWorkspaceCreationProperties$InstanceIamRoleArn' => 'Indicates the IAM role ARN of the instance.
', 'WorkspaceCreationProperties$InstanceIamRoleArn' => 'Indicates the IAM role ARN of the instance.
', 'WorkspaceDirectory$IamRoleId' => 'The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
', 'WorkspacesPool$PoolArn' => 'The Amazon Resource Name (ARN) for the pool.
', ], ], 'AcceptAccountLinkInvitationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptAccountLinkInvitationResult' => [ 'base' => NULL, 'refs' => [], ], 'AccessDeniedException' => [ 'base' => 'The user is not authorized to access a resource.
', 'refs' => [], ], 'AccessPropertyValue' => [ 'base' => NULL, 'refs' => [ 'WorkspaceAccessProperties$DeviceTypeWindows' => 'Indicates whether users can use Windows clients to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeOsx' => 'Indicates whether users can use macOS clients to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeWeb' => 'Indicates whether users can access their WorkSpaces through a web browser.
', 'WorkspaceAccessProperties$DeviceTypeIos' => 'Indicates whether users can use iOS devices to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeAndroid' => 'Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeChromeOs' => 'Indicates whether users can use Chromebooks to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeZeroClient' => 'Indicates whether users can use zero client devices to access their WorkSpaces.
', 'WorkspaceAccessProperties$DeviceTypeLinux' => 'Indicates whether users can use Linux clients to access their WorkSpaces.
', ], ], 'AccountLink' => [ 'base' => 'Information about about the account link.
', 'refs' => [ 'AcceptAccountLinkInvitationResult$AccountLink' => 'Information about the account link.
', 'AccountLinkList$member' => NULL, 'CreateAccountLinkInvitationResult$AccountLink' => 'Information about the account link.
', 'DeleteAccountLinkInvitationResult$AccountLink' => 'Information about the account link.
', 'GetAccountLinkResult$AccountLink' => 'The account link of the account link to retrieve.
', 'RejectAccountLinkInvitationResult$AccountLink' => 'Information about the account link.
', ], ], 'AccountLinkList' => [ 'base' => NULL, 'refs' => [ 'ListAccountLinksResult$AccountLinks' => 'Information about the account links.
', ], ], 'AccountLinkStatusEnum' => [ 'base' => NULL, 'refs' => [ 'AccountLink$AccountLinkStatus' => 'The status of the account link.
', 'LinkStatusFilterList$member' => NULL, ], ], 'AccountModification' => [ 'base' => 'Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.
', 'refs' => [ 'AccountModificationList$member' => NULL, ], ], 'AccountModificationList' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountModificationsResult$AccountModifications' => 'The list of modifications to the configuration of BYOL.
', ], ], 'ActiveDirectoryConfig' => [ 'base' => 'Information about the Active Directory config.
', 'refs' => [ 'RegisterWorkspaceDirectoryRequest$ActiveDirectoryConfig' => 'The active directory config of the directory.
', 'WorkspaceDirectory$ActiveDirectoryConfig' => 'Information about the Active Directory config.
', ], ], 'ActiveUserSessions' => [ 'base' => NULL, 'refs' => [ 'CapacityStatus$ActiveUserSessions' => 'The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.
', ], ], 'ActualUserSessions' => [ 'base' => NULL, 'refs' => [ 'CapacityStatus$ActualUserSessions' => 'The total number of session slots that are available for a pool of WorkSpaces.
', ], ], 'AddInName' => [ 'base' => NULL, 'refs' => [ 'ConnectClientAddIn$Name' => 'The name of the client add in.
', 'CreateConnectClientAddInRequest$Name' => 'The name of the client add-in.
', 'UpdateConnectClientAddInRequest$Name' => 'The name of the client add-in.
', ], ], 'AddInUrl' => [ 'base' => NULL, 'refs' => [ 'ConnectClientAddIn$URL' => 'The endpoint URL of the client add-in.
', 'CreateConnectClientAddInRequest$URL' => 'The endpoint URL of the Amazon Connect client add-in.
', 'UpdateConnectClientAddInRequest$URL' => 'The endpoint URL of the Amazon Connect client add-in.
', ], ], 'Alias' => [ 'base' => NULL, 'refs' => [ 'WorkspaceDirectory$Alias' => 'The directory alias.
', ], ], 'AmazonUuid' => [ 'base' => NULL, 'refs' => [ 'ConnectClientAddIn$AddInId' => 'The client add-in identifier.
', 'CreateConnectClientAddInResult$AddInId' => 'The client add-in identifier.
', 'DeleteConnectClientAddInRequest$AddInId' => 'The identifier of the client add-in to delete.
', 'TerminateWorkspacesPoolSessionRequest$SessionId' => 'The identifier of the pool session.
', 'UpdateConnectClientAddInRequest$AddInId' => 'The identifier of the client add-in to update.
', 'WorkspacesPoolSession$SessionId' => 'The identifier of the session.
', ], ], 'Application' => [ 'base' => NULL, 'refs' => [ 'ApplicationList$member' => NULL, ], ], 'ApplicationAssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'ApplicationAssociatedResourceTypeList$member' => NULL, 'ApplicationResourceAssociation$AssociatedResourceType' => 'The resource type of the associated resource.
', ], ], 'ApplicationAssociatedResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationAssociationsRequest$AssociatedResourceTypes' => 'The resource type of the associated resources.
', ], ], 'ApplicationList' => [ 'base' => NULL, 'refs' => [ 'ImportWorkspaceImageRequest$Applications' => 'If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
Windows 11 only supports Microsoft_Office_2019
.
The specified application is not supported.
', 'refs' => [], ], 'ApplicationResourceAssociation' => [ 'base' => 'Describes the association between an application and an application resource.
', 'refs' => [ 'ApplicationResourceAssociationList$member' => NULL, ], ], 'ApplicationResourceAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationAssociationsResult$Associations' => 'List of associations and information about them.
', ], ], 'ApplicationSettingsRequest' => [ 'base' => 'The persistent application settings for WorkSpaces Pools users.
', 'refs' => [ 'CreateWorkspacesPoolRequest$ApplicationSettings' => 'Indicates the application settings of the pool.
', 'UpdateWorkspacesPoolRequest$ApplicationSettings' => 'The persistent application settings for users in the pool.
', ], ], 'ApplicationSettingsResponse' => [ 'base' => 'Describes the persistent application settings for WorkSpaces Pools users.
', 'refs' => [ 'WorkspacesPool$ApplicationSettings' => 'The persistent application settings for users of the pool.
', ], ], 'ApplicationSettingsStatusEnum' => [ 'base' => NULL, 'refs' => [ 'ApplicationSettingsRequest$Status' => 'Enables or disables persistent application settings for users during their pool sessions.
', 'ApplicationSettingsResponse$Status' => 'Specifies whether persistent application settings are enabled for users during their pool sessions.
', ], ], 'AssociateConnectionAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateConnectionAliasResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociateIpGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateIpGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociateWorkspaceApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateWorkspaceApplicationResult' => [ 'base' => NULL, 'refs' => [], ], 'AssociationErrorCode' => [ 'base' => NULL, 'refs' => [ 'AssociationStateReason$ErrorCode' => 'The error code of the association deployment failure.
', ], ], 'AssociationState' => [ 'base' => NULL, 'refs' => [ 'ApplicationResourceAssociation$State' => 'The status of the application resource association.
', 'BundleResourceAssociation$State' => 'The status of the bundle resource association.
', 'ImageResourceAssociation$State' => 'The status of the image resource association.
', 'WorkspaceResourceAssociation$State' => 'The status of the WorkSpace resource association.
', ], ], 'AssociationStateReason' => [ 'base' => 'Indicates the reason that the association deployment failed, including the error code and error message.
', 'refs' => [ 'ApplicationResourceAssociation$StateReason' => 'The reason the association deployment failed.
', 'BundleResourceAssociation$StateReason' => 'The reason the association deployment failed.
', 'ImageResourceAssociation$StateReason' => 'The reason the association deployment failed.
', 'WorkspaceResourceAssociation$StateReason' => 'The reason the association deployment failed.
', ], ], 'AssociationStatus' => [ 'base' => NULL, 'refs' => [ 'ConnectionAliasAssociation$AssociationStatus' => 'The association status of the connection alias.
', ], ], 'AuthenticationType' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolSession$AuthenticationType' => 'The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).
', ], ], 'AuthorizeIpRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'AuthorizeIpRulesResult' => [ 'base' => NULL, 'refs' => [], ], 'AvailableUserSessions' => [ 'base' => NULL, 'refs' => [ 'CapacityStatus$AvailableUserSessions' => 'The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.
', ], ], 'AwsAccount' => [ 'base' => NULL, 'refs' => [ 'AccountLink$SourceAccountId' => 'The identifier of the source account.
', 'AccountLink$TargetAccountId' => 'The identifier of the target account.
', 'ConnectionAlias$OwnerAccountId' => 'The identifier of the Amazon Web Services account that owns the connection alias.
', 'ConnectionAliasAssociation$AssociatedAccountId' => 'The identifier of the Amazon Web Services account that associated the connection alias with a directory.
', 'ConnectionAliasPermission$SharedAccountId' => 'The identifier of the Amazon Web Services account that the connection alias is shared with.
', 'CreateAccountLinkInvitationRequest$TargetAccountId' => 'The identifier of the target account.
', 'CreateWorkspaceImageResult$OwnerAccountId' => 'The identifier of the Amazon Web Services account that owns the image.
', 'GetAccountLinkRequest$LinkedAccountId' => 'The identifier of the account link
', 'ImagePermission$SharedAccountId' => 'The identifier of the Amazon Web Services account that an image has been shared with.
', 'UpdateWorkspaceImagePermissionRequest$SharedAccountId' => 'The identifier of the Amazon Web Services account to share or unshare the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
The identifier of the Amazon Web Services account that owns the image.
', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'ConnectionAliasPermission$AllowAssociation' => 'Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
', 'DefaultWorkspaceCreationProperties$EnableWorkDocs' => 'Specifies whether the directory is enabled for Amazon WorkDocs.
', 'DefaultWorkspaceCreationProperties$EnableInternetAccess' => 'Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you\'re using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
', 'DefaultWorkspaceCreationProperties$UserEnabledAsLocalAdministrator' => 'Specifies whether WorkSpace users are local administrators on their WorkSpaces.
', 'DefaultWorkspaceCreationProperties$EnableMaintenanceMode' => 'Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
', 'DeployWorkspaceApplicationsRequest$Force' => 'Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.
', 'RegisterWorkspaceDirectoryRequest$EnableWorkDocs' => 'Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs
to disabled, and try again.
Indicates whether self-service capabilities are enabled or disabled.
', 'UpdateResult$UpdateAvailable' => 'Indicates whether updated drivers or other components are available for the specified WorkSpace image.
', 'UpdateWorkspaceImagePermissionRequest$AllowCopyImage' => 'The permission to copy the image. This permission can be revoked only after an image has been shared.
', 'Workspace$UserVolumeEncryptionEnabled' => 'Indicates whether the data stored on the user volume is encrypted.
', 'Workspace$RootVolumeEncryptionEnabled' => 'Indicates whether the data stored on the root volume is encrypted.
', 'WorkspaceCreationProperties$EnableWorkDocs' => 'Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users\' access to WorkDocs or you delete the WorkDocs site. To disable users\' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
Indicates whether internet access is enabled for your WorkSpaces.
', 'WorkspaceCreationProperties$UserEnabledAsLocalAdministrator' => 'Indicates whether users are local administrators of their WorkSpaces.
', 'WorkspaceCreationProperties$EnableMaintenanceMode' => 'Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
', 'WorkspaceRequest$UserVolumeEncryptionEnabled' => 'Indicates whether the data stored on the user volume is encrypted.
', 'WorkspaceRequest$RootVolumeEncryptionEnabled' => 'Indicates whether the data stored on the root volume is encrypted.
', ], ], 'BundleAssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'BundleAssociatedResourceTypeList$member' => NULL, 'BundleResourceAssociation$AssociatedResourceType' => 'The resource type of the associated resources.
', ], ], 'BundleAssociatedResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeBundleAssociationsRequest$AssociatedResourceTypes' => 'The resource types of the associated resource.
', ], ], 'BundleId' => [ 'base' => NULL, 'refs' => [ 'BundleIdList$member' => NULL, 'BundleResourceAssociation$BundleId' => 'The identifier of the bundle.
', 'CreateWorkspacesPoolRequest$BundleId' => 'The identifier of the bundle for the pool.
', 'DeleteWorkspaceBundleRequest$BundleId' => 'The identifier of the bundle.
', 'DescribeBundleAssociationsRequest$BundleId' => 'The identifier of the bundle.
', 'DescribeWorkspacesRequest$BundleId' => 'The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
', 'MigrateWorkspaceRequest$BundleId' => 'The identifier of the target bundle type to migrate the WorkSpace to.
', 'UpdateWorkspaceBundleRequest$BundleId' => 'The identifier of the bundle.
', 'UpdateWorkspacesPoolRequest$BundleId' => 'The identifier of the bundle.
', 'Workspace$BundleId' => 'The identifier of the bundle used to create the WorkSpace.
', 'WorkspaceBundle$BundleId' => 'The identifier of the bundle.
', 'WorkspaceRequest$BundleId' => 'The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
', 'WorkspacesPool$BundleId' => 'The identifier of the bundle used by the pool.
', ], ], 'BundleIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceBundlesRequest$BundleIds' => 'The identifiers of the bundles. You cannot combine this parameter with any other filter.
', ], ], 'BundleList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceBundlesResult$Bundles' => 'Information about the bundles.
', ], ], 'BundleOwner' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceBundlesRequest$Owner' => 'The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON
. To describe the bundles that belong to your account, don\'t specify a value.
The owner of the bundle. This is the account identifier of the owner, or AMAZON
if the bundle is provided by Amazon Web Services.
Describes the association between an application and a bundle resource.
', 'refs' => [ 'BundleResourceAssociationList$member' => NULL, ], ], 'BundleResourceAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeBundleAssociationsResult$Associations' => 'List of information about the specified associations.
', ], ], 'BundleType' => [ 'base' => NULL, 'refs' => [ 'WorkspaceBundle$BundleType' => 'The type of WorkSpace bundle.
', ], ], 'Capacity' => [ 'base' => 'Describes the user capacity for a pool of WorkSpaces.
', 'refs' => [ 'CreateWorkspacesPoolRequest$Capacity' => 'The user capacity of the pool.
', 'UpdateWorkspacesPoolRequest$Capacity' => 'The desired capacity for the pool.
', ], ], 'CapacityStatus' => [ 'base' => 'Describes the capacity status for a pool of WorkSpaces.
', 'refs' => [ 'WorkspacesPool$CapacityStatus' => 'The capacity status for the pool
', ], ], 'CertificateAuthorityArn' => [ 'base' => NULL, 'refs' => [ 'CertificateBasedAuthProperties$CertificateAuthorityArn' => 'The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
', ], ], 'CertificateBasedAuthProperties' => [ 'base' => 'Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.
', 'refs' => [ 'ModifyCertificateBasedAuthPropertiesRequest$CertificateBasedAuthProperties' => 'The properties of the certificate-based authentication.
', 'WorkspaceDirectory$CertificateBasedAuthProperties' => 'The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
', ], ], 'CertificateBasedAuthStatusEnum' => [ 'base' => NULL, 'refs' => [ 'CertificateBasedAuthProperties$Status' => 'The status of the certificate-based authentication properties.
', ], ], 'ClientDeviceType' => [ 'base' => NULL, 'refs' => [ 'ClientDeviceTypeList$member' => NULL, ], ], 'ClientDeviceTypeList' => [ 'base' => NULL, 'refs' => [ 'DeleteClientBrandingRequest$Platforms' => 'The device type for which you want to delete client branding.
', ], ], 'ClientEmail' => [ 'base' => NULL, 'refs' => [ 'DefaultClientBrandingAttributes$SupportEmail' => 'The support email. The company\'s customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com
.
The support email. The company\'s customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com
.
The support email. The company\'s customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com
.
The support email. The company\'s customer support email address.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com
.
Describes an Amazon WorkSpaces client.
', 'refs' => [ 'ClientPropertiesResult$ClientProperties' => 'Information about the Amazon WorkSpaces client.
', 'ModifyClientPropertiesRequest$ClientProperties' => 'Information about the Amazon WorkSpaces client.
', ], ], 'ClientPropertiesList' => [ 'base' => NULL, 'refs' => [ 'DescribeClientPropertiesResult$ClientPropertiesList' => 'Information about the specified Amazon WorkSpaces clients.
', ], ], 'ClientPropertiesResult' => [ 'base' => 'Information about the Amazon WorkSpaces client.
', 'refs' => [ 'ClientPropertiesList$member' => NULL, ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'AcceptAccountLinkInvitationRequest$ClientToken' => 'A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
', 'CreateAccountLinkInvitationRequest$ClientToken' => 'A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
', 'DeleteAccountLinkInvitationRequest$ClientToken' => 'A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
', 'RejectAccountLinkInvitationRequest$ClientToken' => 'The client token of the account link invitation to reject.
', ], ], 'ClientUrl' => [ 'base' => NULL, 'refs' => [ 'DefaultClientBrandingAttributes$LogoUrl' => 'The logo. The only image format accepted is a binary data object that is converted from a .png
file.
The support link. The link for the company\'s customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com
.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
', 'DefaultImportClientBrandingAttributes$SupportLink' => 'The support link. The link for the company\'s customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com
.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
', 'IosClientBrandingAttributes$LogoUrl' => 'The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png
file.
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The support link. The link for the company\'s customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com
.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
', 'IosImportClientBrandingAttributes$SupportLink' => 'The support link. The link for the company\'s customer support page for their WorkSpace.
In each platform type, the SupportEmail
and SupportLink
parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com
.
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
', ], ], 'Compute' => [ 'base' => NULL, 'refs' => [ 'ComputeList$member' => NULL, 'ComputeType$Name' => 'The compute type.
', 'WorkspaceProperties$ComputeTypeName' => 'The compute type. For more information, see Amazon WorkSpaces Bundles.
', ], ], 'ComputeList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$ComputeTypeNames' => 'The compute types supported by the applications.
', 'WorkSpaceApplication$SupportedComputeTypeNames' => 'The supported compute types of the WorkSpace application.
', ], ], 'ComputeNotCompatibleException' => [ 'base' => 'The compute type of the WorkSpace is not compatible with the application.
', 'refs' => [], ], 'ComputeType' => [ 'base' => 'Describes the compute type of the bundle.
', 'refs' => [ 'CreateWorkspaceBundleRequest$ComputeType' => NULL, 'WorkspaceBundle$ComputeType' => 'The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
', ], ], 'ComputerName' => [ 'base' => NULL, 'refs' => [ 'Workspace$ComputerName' => 'The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
', ], ], 'ConflictException' => [ 'base' => 'The TargetAccountId
is already linked or invited.
Describes an Amazon Connect client add-in.
', 'refs' => [ 'ConnectClientAddInList$member' => NULL, ], ], 'ConnectClientAddInList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectClientAddInsResult$AddIns' => 'Information about client add-ins.
', ], ], 'ConnectionAlias' => [ 'base' => 'Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'refs' => [ 'ConnectionAliasList$member' => NULL, ], ], 'ConnectionAliasAssociation' => [ 'base' => 'Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'refs' => [ 'ConnectionAliasAssociationList$member' => NULL, ], ], 'ConnectionAliasAssociationList' => [ 'base' => NULL, 'refs' => [ 'ConnectionAlias$Associations' => 'The association status of the connection alias.
', ], ], 'ConnectionAliasId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectionAliasRequest$AliasId' => 'The identifier of the connection alias.
', 'ConnectionAlias$AliasId' => 'The identifier of the connection alias.
', 'ConnectionAliasIdList$member' => NULL, 'CreateConnectionAliasResult$AliasId' => 'The identifier of the connection alias.
', 'DeleteConnectionAliasRequest$AliasId' => 'The identifier of the connection alias to delete.
', 'DescribeConnectionAliasPermissionsRequest$AliasId' => 'The identifier of the connection alias.
', 'DescribeConnectionAliasPermissionsResult$AliasId' => 'The identifier of the connection alias.
', 'DisassociateConnectionAliasRequest$AliasId' => 'The identifier of the connection alias to disassociate.
', 'UpdateConnectionAliasPermissionRequest$AliasId' => 'The identifier of the connection alias that you want to update permissions for.
', ], ], 'ConnectionAliasIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectionAliasesRequest$AliasIds' => 'The identifiers of the connection aliases to describe.
', ], ], 'ConnectionAliasList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectionAliasesResult$ConnectionAliases' => 'Information about the specified connection aliases.
', ], ], 'ConnectionAliasPermission' => [ 'base' => 'Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
', 'refs' => [ 'ConnectionAliasPermissions$member' => NULL, 'UpdateConnectionAliasPermissionRequest$ConnectionAliasPermission' => 'Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.
', ], ], 'ConnectionAliasPermissions' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectionAliasPermissionsResult$ConnectionAliasPermissions' => 'The permissions associated with a connection alias.
', ], ], 'ConnectionAliasState' => [ 'base' => NULL, 'refs' => [ 'ConnectionAlias$State' => 'The current state of the connection alias.
', ], ], 'ConnectionIdentifier' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectionAliasResult$ConnectionIdentifier' => 'The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you\'re configuring your DNS routing policies.
', 'ConnectionAliasAssociation$ConnectionIdentifier' => 'The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you\'re configuring your DNS routing policies.
', ], ], 'ConnectionState' => [ 'base' => NULL, 'refs' => [ 'WorkspaceConnectionStatus$ConnectionState' => 'The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
', ], ], 'ConnectionString' => [ 'base' => NULL, 'refs' => [ 'ConnectionAlias$ConnectionString' => 'The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com
.
A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com
.
After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
Indicates whether data replication is enabled, and if enabled, the type of data replication.
', 'ModifyWorkspacePropertiesRequest$DataReplication' => 'Indicates the data replication status.
', 'StandbyWorkspace$DataReplication' => 'Indicates whether data replication is enabled, and if enabled, the type of data replication.
', 'StandbyWorkspacesProperties$DataReplication' => 'Indicates whether data replication is enabled, and if enabled, the type of data replication.
', ], ], 'DataReplicationSettings' => [ 'base' => 'Describes the data replication settings.
', 'refs' => [ 'Workspace$DataReplicationSettings' => 'Indicates the settings of the data replication.
', ], ], 'DedicatedTenancyAccountType' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountResult$DedicatedTenancyAccountType' => 'The type of linked account.
', ], ], 'DedicatedTenancyCidrRangeList' => [ 'base' => NULL, 'refs' => [ 'ListAvailableManagementCidrRangesResult$ManagementCidrRanges' => 'The list of available IP address ranges, specified as IPv4 CIDR blocks.
', ], ], 'DedicatedTenancyManagementCidrRange' => [ 'base' => NULL, 'refs' => [ 'AccountModification$DedicatedTenancyManagementCidrRange' => 'The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
', 'DedicatedTenancyCidrRangeList$member' => NULL, 'DescribeAccountResult$DedicatedTenancyManagementCidrRange' => 'The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
', 'ModifyAccountRequest$DedicatedTenancyManagementCidrRange' => 'The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges
operation.
The state of the modification to the configuration of BYOL.
', ], ], 'DedicatedTenancySupportEnum' => [ 'base' => NULL, 'refs' => [ 'ModifyAccountRequest$DedicatedTenancySupport' => 'The status of BYOL.
', ], ], 'DedicatedTenancySupportResultEnum' => [ 'base' => NULL, 'refs' => [ 'AccountModification$DedicatedTenancySupport' => 'The status of BYOL (whether BYOL is being enabled or disabled).
', 'DescribeAccountResult$DedicatedTenancySupport' => 'The status of BYOL (whether BYOL is enabled or disabled).
', ], ], 'DefaultClientBrandingAttributes' => [ 'base' => 'Returns default client branding attributes that were imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you don\'t include sensitive information.
The branding information for Windows devices.
', 'DescribeClientBrandingResult$DeviceTypeOsx' => 'The branding information for macOS devices.
', 'DescribeClientBrandingResult$DeviceTypeAndroid' => 'The branding information for Android devices.
', 'DescribeClientBrandingResult$DeviceTypeLinux' => 'The branding information for Linux devices.
', 'DescribeClientBrandingResult$DeviceTypeWeb' => 'The branding information for Web access.
', 'ImportClientBrandingResult$DeviceTypeWindows' => 'The branding information configured for Windows devices.
', 'ImportClientBrandingResult$DeviceTypeOsx' => 'The branding information configured for macOS devices.
', 'ImportClientBrandingResult$DeviceTypeAndroid' => 'The branding information configured for Android devices.
', 'ImportClientBrandingResult$DeviceTypeLinux' => 'The branding information configured for Linux devices.
', 'ImportClientBrandingResult$DeviceTypeWeb' => 'The branding information configured for web access.
', ], ], 'DefaultImportClientBrandingAttributes' => [ 'base' => 'The default client branding attributes to be imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you do not include sensitive information.
The branding information to import for Windows devices.
', 'ImportClientBrandingRequest$DeviceTypeOsx' => 'The branding information to import for macOS devices.
', 'ImportClientBrandingRequest$DeviceTypeAndroid' => 'The branding information to import for Android devices.
', 'ImportClientBrandingRequest$DeviceTypeLinux' => 'The branding information to import for Linux devices.
', 'ImportClientBrandingRequest$DeviceTypeWeb' => 'The branding information to import for web access.
', ], ], 'DefaultLogo' => [ 'base' => NULL, 'refs' => [ 'DefaultImportClientBrandingAttributes$Logo' => 'The logo. The only image format accepted is a binary data object that is converted from a .png
file.
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
', 'WorkspaceCreationProperties$DefaultOu' => 'The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value"
, where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com
.
To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
The API doesn\'t validate whether the OU exists.
Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
', 'refs' => [ 'WorkspaceDirectory$WorkspaceCreationProperties' => 'The default creation properties for all WorkSpaces in the directory.
', ], ], 'DeletableCertificateBasedAuthPropertiesList' => [ 'base' => NULL, 'refs' => [ 'ModifyCertificateBasedAuthPropertiesRequest$PropertiesToDelete' => 'The properties of the certificate-based authentication you want to delete.
', ], ], 'DeletableCertificateBasedAuthProperty' => [ 'base' => NULL, 'refs' => [ 'DeletableCertificateBasedAuthPropertiesList$member' => NULL, ], ], 'DeletableSamlPropertiesList' => [ 'base' => NULL, 'refs' => [ 'ModifySamlPropertiesRequest$PropertiesToDelete' => 'The SAML properties to delete as part of your request.
Specify one of the following options:
SAML_PROPERTIES_USER_ACCESS_URL
to delete the user access URL.
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
to delete the relay state parameter name.
Describes the filter conditions for WorkSpaces Pools to return.
', 'refs' => [ 'DescribeWorkspacesPoolsFilters$member' => NULL, ], ], 'DescribeWorkspacesPoolsFilterName' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsFilter$Name' => 'The name of the pool to filter.
', ], ], 'DescribeWorkspacesPoolsFilterOperator' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsFilter$Operator' => 'The operator values for filtering WorkSpaces Pools.
', ], ], 'DescribeWorkspacesPoolsFilterValue' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsFilterValues$member' => NULL, ], ], 'DescribeWorkspacesPoolsFilterValues' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsFilter$Values' => 'The values for filtering WorkSpaces Pools.
', ], ], 'DescribeWorkspacesPoolsFilters' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsRequest$Filters' => 'The filter conditions for the WorkSpaces Pool to return.
', ], ], 'DescribeWorkspacesPoolsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkspacesPoolsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AccountModification$ErrorMessage' => 'The text of the error message that is returned if the configuration of BYOL cannot be modified.
', 'ErrorDetails$ErrorMessage' => 'The text of the error message related the error code.
', 'FailedCreateStandbyWorkspacesRequest$ErrorMessage' => 'The text of the error message that is returned if the standby WorkSpace could not be created.
', 'FailedCreateWorkspaceRequest$ErrorMessage' => 'The text of the error message that is returned if the WorkSpace cannot be created.
', 'FailedWorkspaceChangeRequest$ErrorMessage' => 'The text of the error message that is returned if the WorkSpace cannot be rebooted.
', 'Workspace$ErrorMessage' => 'The text of the error message that is returned if the WorkSpace cannot be created.
', 'WorkspaceBundle$Description' => 'The description of the bundle.
', 'WorkspaceDirectory$ErrorMessage' => 'The error message returned.
', 'WorkspaceImage$ErrorMessage' => 'The text of the error message that is returned for the image.
', ], ], 'DesiredUserSessions' => [ 'base' => NULL, 'refs' => [ 'Capacity$DesiredUserSessions' => 'The desired number of user sessions for a multi-session pool. This is not allowed for single-session pools.
', 'CapacityStatus$DesiredUserSessions' => 'The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.
', ], ], 'DirectoryId' => [ 'base' => NULL, 'refs' => [ 'AssociateIpGroupsRequest$DirectoryId' => 'The identifier of the directory.
', 'ConnectClientAddIn$ResourceId' => 'The directory identifier for which the client add-in is configured.
', 'CreateConnectClientAddInRequest$ResourceId' => 'The directory identifier for which to configure the client add-in.
', 'CreateWorkspacesPoolRequest$DirectoryId' => 'The identifier of the directory for the pool.
', 'DeleteClientBrandingRequest$ResourceId' => 'The directory identifier of the WorkSpace for which you want to delete client branding.
', 'DeleteConnectClientAddInRequest$ResourceId' => 'The directory identifier for which the client add-in is configured.
', 'DeregisterWorkspaceDirectoryRequest$DirectoryId' => 'The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
', 'DescribeClientBrandingRequest$ResourceId' => 'The directory identifier of the WorkSpace for which you want to view client branding information.
', 'DescribeConnectClientAddInsRequest$ResourceId' => 'The directory identifier for which the client add-in is configured.
', 'DescribeWorkspacesRequest$DirectoryId' => 'The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName
). You cannot combine this parameter with any other filter.
The identifier of the directory.
', 'ImportClientBrandingRequest$ResourceId' => 'The directory identifier of the WorkSpace for which you want to import client branding.
', 'ModifyCertificateBasedAuthPropertiesRequest$ResourceId' => 'The resource identifiers, in the form of directory IDs.
', 'ModifySamlPropertiesRequest$ResourceId' => 'The directory identifier for which you want to configure SAML properties.
', 'ModifySelfservicePermissionsRequest$ResourceId' => 'The identifier of the directory.
', 'ModifyStreamingPropertiesRequest$ResourceId' => 'The identifier of the resource.
', 'ModifyWorkspaceAccessPropertiesRequest$ResourceId' => 'The identifier of the directory.
', 'ModifyWorkspaceCreationPropertiesRequest$ResourceId' => 'The identifier of the directory.
', 'PendingCreateStandbyWorkspacesRequest$DirectoryId' => 'The identifier of the directory for the standby WorkSpace.
', 'RegisterWorkspaceDirectoryRequest$DirectoryId' => 'The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
', 'RegisterWorkspaceDirectoryResult$DirectoryId' => 'The identifier of the directory.
', 'StandbyWorkspace$DirectoryId' => 'The identifier of the directory for the standby WorkSpace.
', 'UpdateConnectClientAddInRequest$ResourceId' => 'The directory identifier for which the client add-in is configured.
', 'UpdateWorkspacesPoolRequest$DirectoryId' => 'The identifier of the directory.
', 'Workspace$DirectoryId' => 'The identifier of the Directory Service directory for the WorkSpace.
', 'WorkspaceDirectory$DirectoryId' => 'The directory identifier.
', 'WorkspaceRequest$DirectoryId' => 'The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
', 'WorkspacesPool$DirectoryId' => 'The identifier of the directory used by the pool.
', ], ], 'DirectoryIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceDirectoriesRequest$DirectoryIds' => 'The identifiers of the directories. If the value is null, all directories are retrieved.
', ], ], 'DirectoryList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceDirectoriesResult$Directories' => 'Information about the directories.
', ], ], 'DirectoryName' => [ 'base' => NULL, 'refs' => [ 'WorkspaceDirectory$DirectoryName' => 'The name of the directory.
', ], ], 'DisassociateConnectionAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateConnectionAliasResult' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateIpGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateIpGroupsResult' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateWorkspaceApplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateWorkspaceApplicationResult' => [ 'base' => NULL, 'refs' => [], ], 'DisconnectTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'TimeoutSettings$DisconnectTimeoutInSeconds' => 'Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
', ], ], 'DnsIpAddresses' => [ 'base' => NULL, 'refs' => [ 'WorkspaceDirectory$DnsIpAddresses' => 'The IP addresses of the DNS servers for the directory.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'ActiveDirectoryConfig$DomainName' => 'The name of the domain.
', ], ], 'Ec2ImageId' => [ 'base' => NULL, 'refs' => [ 'ImportWorkspaceImageRequest$Ec2ImageId' => 'The identifier of the EC2 image.
', ], ], 'ErrorDetails' => [ 'base' => 'Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
', 'refs' => [ 'ErrorDetailsList$member' => NULL, ], ], 'ErrorDetailsList' => [ 'base' => NULL, 'refs' => [ 'WorkspaceImage$ErrorDetails' => 'Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolError$ErrorMessage' => 'The error message.
', ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'FailedCreateWorkspaceRequest$ErrorCode' => 'The error code that is returned if the WorkSpace cannot be created.
', 'FailedWorkspaceChangeRequest$ErrorCode' => 'The error code that is returned if the WorkSpace cannot be rebooted.
', ], ], 'ExceptionErrorCode' => [ 'base' => NULL, 'refs' => [ 'OperationNotSupportedException$reason' => 'The exception error reason.
', ], ], 'ExceptionMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'InternalServerException$message' => NULL, 'InvalidParameterValuesException$message' => 'The exception error message.
', 'InvalidResourceStateException$message' => NULL, 'OperationInProgressException$message' => NULL, 'OperationNotSupportedException$message' => 'The exception error message.
', 'ResourceAlreadyExistsException$message' => NULL, 'ResourceAssociatedException$message' => NULL, 'ResourceCreationFailedException$message' => NULL, 'ResourceInUseException$message' => NULL, 'ResourceLimitExceededException$message' => 'The exception error message.
', 'ResourceNotFoundException$message' => 'The resource could not be found.
', 'ResourceUnavailableException$message' => 'The exception error message.
', 'UnsupportedNetworkConfigurationException$message' => NULL, 'UnsupportedWorkspaceConfigurationException$message' => NULL, 'ValidationException$message' => NULL, 'WorkspacesDefaultRoleNotFoundException$message' => NULL, ], ], 'FailedCreateStandbyWorkspacesRequest' => [ 'base' => 'Describes the standby WorkSpace that could not be created.
', 'refs' => [ 'FailedCreateStandbyWorkspacesRequestList$member' => NULL, ], ], 'FailedCreateStandbyWorkspacesRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateStandbyWorkspacesResult$FailedStandbyRequests' => 'Information about the standby WorkSpace that could not be created.
', ], ], 'FailedCreateWorkspaceRequest' => [ 'base' => 'Describes a WorkSpace that cannot be created.
', 'refs' => [ 'FailedCreateWorkspaceRequests$member' => NULL, ], ], 'FailedCreateWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be created.
', ], ], 'FailedRebootWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'RebootWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be rebooted.
', ], ], 'FailedRebuildWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'RebuildWorkspacesResult$FailedRequests' => 'Information about the WorkSpace that could not be rebuilt.
', ], ], 'FailedStartWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'StartWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be started.
', ], ], 'FailedStopWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'StopWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be stopped.
', ], ], 'FailedTerminateWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'TerminateWorkspacesResult$FailedRequests' => 'Information about the WorkSpaces that could not be terminated.
', ], ], 'FailedWorkspaceChangeRequest' => [ 'base' => 'Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
', 'refs' => [ 'FailedRebootWorkspaceRequests$member' => NULL, 'FailedRebuildWorkspaceRequests$member' => NULL, 'FailedStartWorkspaceRequests$member' => NULL, 'FailedStopWorkspaceRequests$member' => NULL, 'FailedTerminateWorkspaceRequests$member' => NULL, ], ], 'GetAccountLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAccountLinkResult' => [ 'base' => NULL, 'refs' => [], ], 'IdleDisconnectTimeoutInSeconds' => [ 'base' => NULL, 'refs' => [ 'TimeoutSettings$IdleDisconnectTimeoutInSeconds' => 'The amount of time in seconds a connection will stay active while idle.
', ], ], 'ImageAssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'ImageAssociatedResourceTypeList$member' => NULL, 'ImageResourceAssociation$AssociatedResourceType' => 'The resource type of the associated resources.
', ], ], 'ImageAssociatedResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeImageAssociationsRequest$AssociatedResourceTypes' => 'The resource types of the associated resource.
', ], ], 'ImagePermission' => [ 'base' => 'Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
', 'refs' => [ 'ImagePermissions$member' => NULL, ], ], 'ImagePermissions' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceImagePermissionsResult$ImagePermissions' => 'The identifiers of the Amazon Web Services accounts that the image has been shared with.
', ], ], 'ImageResourceAssociation' => [ 'base' => 'Describes the association between an application and an image resource.
', 'refs' => [ 'ImageResourceAssociationList$member' => NULL, ], ], 'ImageResourceAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeImageAssociationsResult$Associations' => 'List of information about the specified associations.
', ], ], 'ImageType' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceImagesRequest$ImageType' => 'The type (owned or shared) of the image.
', ], ], 'ImportClientBrandingRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportClientBrandingResult' => [ 'base' => NULL, 'refs' => [], ], 'ImportWorkspaceImageRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportWorkspaceImageResult' => [ 'base' => NULL, 'refs' => [], ], 'IncompatibleApplicationsException' => [ 'base' => 'The specified application is not compatible with the resource.
', 'refs' => [], ], 'InternalServerException' => [ 'base' => 'Unexpected server error occured.
', 'refs' => [], ], 'InvalidParameterValuesException' => [ 'base' => 'One or more parameter values are not valid.
', 'refs' => [], ], 'InvalidResourceStateException' => [ 'base' => 'The state of the resource is not valid for this operation.
', 'refs' => [], ], 'Ios2XLogo' => [ 'base' => NULL, 'refs' => [ 'IosImportClientBrandingAttributes$Logo2x' => 'The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png
file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.
Client branding attributes are public facing. Ensure you do not include sensitive information.
The branding information for iOS devices.
', 'ImportClientBrandingResult$DeviceTypeIos' => 'The branding information configured for iOS devices.
', ], ], 'IosImportClientBrandingAttributes' => [ 'base' => 'The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.
Client branding attributes are public facing. Ensure you do not include sensitive information.
The branding information to import for iOS devices.
', ], ], 'IosLogo' => [ 'base' => NULL, 'refs' => [ 'IosImportClientBrandingAttributes$Logo' => 'The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png
file.
The IP address of the WorkSpace.
', ], ], 'IpGroupDesc' => [ 'base' => NULL, 'refs' => [ 'CreateIpGroupRequest$GroupDesc' => 'The description of the group.
', 'WorkspacesIpGroup$groupDesc' => 'The description of the group.
', ], ], 'IpGroupId' => [ 'base' => NULL, 'refs' => [ 'AuthorizeIpRulesRequest$GroupId' => 'The identifier of the group.
', 'CreateIpGroupResult$GroupId' => 'The identifier of the group.
', 'DeleteIpGroupRequest$GroupId' => 'The identifier of the IP access control group.
', 'IpGroupIdList$member' => NULL, 'RevokeIpRulesRequest$GroupId' => 'The identifier of the group.
', 'UpdateRulesOfIpGroupRequest$GroupId' => 'The identifier of the group.
', 'WorkspacesIpGroup$groupId' => 'The identifier of the group.
', ], ], 'IpGroupIdList' => [ 'base' => NULL, 'refs' => [ 'AssociateIpGroupsRequest$GroupIds' => 'The identifiers of one or more IP access control groups.
', 'DescribeIpGroupsRequest$GroupIds' => 'The identifiers of one or more IP access control groups.
', 'DisassociateIpGroupsRequest$GroupIds' => 'The identifiers of one or more IP access control groups.
', 'WorkspaceDirectory$ipGroupIds' => 'The identifiers of the IP access control groups associated with the directory.
', ], ], 'IpGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateIpGroupRequest$GroupName' => 'The name of the group.
', 'WorkspacesIpGroup$groupName' => 'The name of the group.
', ], ], 'IpRevokedRuleList' => [ 'base' => NULL, 'refs' => [ 'RevokeIpRulesRequest$UserRules' => 'The rules to remove from the group.
', ], ], 'IpRule' => [ 'base' => NULL, 'refs' => [ 'IpRevokedRuleList$member' => NULL, 'IpRuleItem$ipRule' => 'The IP address range, in CIDR notation.
', ], ], 'IpRuleDesc' => [ 'base' => NULL, 'refs' => [ 'IpRuleItem$ruleDesc' => 'The description.
', ], ], 'IpRuleItem' => [ 'base' => 'Describes a rule for an IP access control group.
', 'refs' => [ 'IpRuleList$member' => NULL, ], ], 'IpRuleList' => [ 'base' => NULL, 'refs' => [ 'AuthorizeIpRulesRequest$UserRules' => 'The rules to add to the group.
', 'CreateIpGroupRequest$UserRules' => 'The rules to add to the group.
', 'UpdateRulesOfIpGroupRequest$UserRules' => 'One or more rules.
', 'WorkspacesIpGroup$userRules' => 'The rules.
', ], ], 'Limit' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationAssociationsRequest$MaxResults' => 'The maximum number of associations to return.
', 'DescribeApplicationsRequest$MaxResults' => 'The maximum number of applications to return.
', 'DescribeConnectClientAddInsRequest$MaxResults' => 'The maximum number of items to return.
', 'DescribeConnectionAliasPermissionsRequest$MaxResults' => 'The maximum number of results to return.
', 'DescribeConnectionAliasesRequest$Limit' => 'The maximum number of connection aliases to return.
', 'DescribeIpGroupsRequest$MaxResults' => 'The maximum number of items to return.
', 'DescribeWorkspaceDirectoriesRequest$Limit' => 'The maximum number of directories to return.
', 'DescribeWorkspaceImagePermissionsRequest$MaxResults' => 'The maximum number of items to return.
', 'DescribeWorkspaceImagesRequest$MaxResults' => 'The maximum number of items to return.
', 'DescribeWorkspacesPoolsRequest$Limit' => 'The maximum number of items to return.
', 'DescribeWorkspacesRequest$Limit' => 'The maximum number of items to return.
', 'ListAccountLinksRequest$MaxResults' => 'The maximum number of accounts to return.
', ], ], 'Limit50' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolSessionsRequest$Limit' => 'The maximum number of items to return.
', ], ], 'LinkId' => [ 'base' => NULL, 'refs' => [ 'AcceptAccountLinkInvitationRequest$LinkId' => 'The identifier of the account link.
', 'AccountLink$AccountLinkId' => 'The identifier of the account link.
', 'DeleteAccountLinkInvitationRequest$LinkId' => 'The identifier of the account link.
', 'GetAccountLinkRequest$LinkId' => 'The identifier of the account to link.
', 'RejectAccountLinkInvitationRequest$LinkId' => 'The identifier of the account link
', ], ], 'LinkStatusFilterList' => [ 'base' => NULL, 'refs' => [ 'ListAccountLinksRequest$LinkStatusFilter' => 'Filters the account based on their link status.
', ], ], 'ListAccountLinksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccountLinksResult' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagementCidrRangesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailableManagementCidrRangesResult' => [ 'base' => NULL, 'refs' => [], ], 'LogUploadEnum' => [ 'base' => NULL, 'refs' => [ 'ClientProperties$LogUploadEnabled' => 'Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.
', ], ], 'LoginMessage' => [ 'base' => NULL, 'refs' => [ 'DefaultClientBrandingAttributes$LoginMessage' => 'The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US
. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US
. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US
. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US
. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul
.
The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
', ], ], 'ManagementCidrRangeMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAvailableManagementCidrRangesRequest$MaxResults' => 'The maximum number of items to return.
', ], ], 'MaxUserDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'TimeoutSettings$MaxUserDurationInSeconds' => 'Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
', ], ], 'MaximumLength' => [ 'base' => NULL, 'refs' => [ 'UserSetting$MaximumLength' => 'Indicates the maximum character length for the specified user setting.
', ], ], 'MigrateWorkspaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'MigrateWorkspaceResult' => [ 'base' => NULL, 'refs' => [], ], 'ModificationResourceEnum' => [ 'base' => NULL, 'refs' => [ 'ModificationState$Resource' => 'The resource.
', ], ], 'ModificationState' => [ 'base' => 'Describes a WorkSpace modification.
', 'refs' => [ 'ModificationStateList$member' => NULL, ], ], 'ModificationStateEnum' => [ 'base' => NULL, 'refs' => [ 'ModificationState$State' => 'The modification state.
', ], ], 'ModificationStateList' => [ 'base' => NULL, 'refs' => [ 'Workspace$ModificationStates' => 'The modification states of the WorkSpace.
', ], ], 'ModifyAccountRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyAccountResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCertificateBasedAuthPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyCertificateBasedAuthPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClientPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClientPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifySamlPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifySamlPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifySelfservicePermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifySelfservicePermissionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyStreamingPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyStreamingPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceAccessPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceAccessPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceCreationPropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceCreationPropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspacePropertiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspacePropertiesResult' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyWorkspaceStateResult' => [ 'base' => NULL, 'refs' => [], ], 'NetworkAccessConfiguration' => [ 'base' => 'Describes the network details of a WorkSpaces Pool.
', 'refs' => [ 'WorkspacesPoolSession$NetworkAccessConfiguration' => 'Describes the network details of the pool.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'ApplicationResourceAssociation$AssociatedResourceId' => 'The identifier of the associated resource.
', 'AssociateConnectionAliasRequest$ResourceId' => 'The identifier of the directory to associate the connection alias with.
', 'BundleResourceAssociation$AssociatedResourceId' => 'The identifier of the associated resource.
', 'ClientPropertiesResult$ResourceId' => 'The resource identifier, in the form of a directory ID.
', 'ConnectionAliasAssociation$ResourceId' => 'The identifier of the directory associated with a connection alias.
', 'CreateTagsRequest$ResourceId' => 'The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
', 'DeleteTagsRequest$ResourceId' => 'The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
', 'DescribeConnectionAliasesRequest$ResourceId' => 'The identifier of the directory associated with the connection alias.
', 'DescribeTagsRequest$ResourceId' => 'The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
', 'ImageResourceAssociation$AssociatedResourceId' => 'The identifier of the associated resource.
', 'ModifyClientPropertiesRequest$ResourceId' => 'The resource identifiers, in the form of directory IDs.
', 'NetworkAccessConfiguration$EniPrivateIpAddress' => 'The private IP address of the elastic network interface that is attached to instances in your VPC.
', 'NetworkAccessConfiguration$EniId' => 'The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
', 'ResourceIdList$member' => NULL, 'ResourceInUseException$ResourceId' => 'The ID of the resource that is in use.
', 'ResourceNotFoundException$ResourceId' => 'The ID of the resource that could not be found.
', 'ResourceUnavailableException$ResourceId' => 'The identifier of the resource that is not available.
', 'RootStorage$Capacity' => 'The size of the root volume.
', 'SamlProperties$RelayStateParameterName' => 'The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
', 'TagKeyList$member' => NULL, 'UserStorage$Capacity' => 'The size of the user volume.
', 'WorkSpaceApplication$Name' => 'The name of the WorkSpace application.
', 'WorkspaceBundle$Name' => 'The name of the bundle.
', 'WorkspaceResourceAssociation$AssociatedResourceId' => 'The identifier of the associated resource.
', ], ], 'OperatingSystem' => [ 'base' => 'The operating system that the image is running.
', 'refs' => [ 'CreateWorkspaceImageResult$OperatingSystem' => 'The operating system that the image is running.
', 'WorkspaceImage$OperatingSystem' => 'The operating system that the image is running.
', ], ], 'OperatingSystemName' => [ 'base' => NULL, 'refs' => [ 'OperatingSystemNameList$member' => NULL, 'WorkspaceProperties$OperatingSystemName' => 'The name of the operating system.
', ], ], 'OperatingSystemNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$OperatingSystemNames' => 'The operating systems supported by the applications.
', 'WorkSpaceApplication$SupportedOperatingSystemNames' => 'The supported operating systems of the WorkSpace application.
', ], ], 'OperatingSystemNotCompatibleException' => [ 'base' => 'The operating system of the WorkSpace is not compatible with the application.
', 'refs' => [], ], 'OperatingSystemType' => [ 'base' => NULL, 'refs' => [ 'OperatingSystem$Type' => 'The operating system.
', ], ], 'OperationInProgressException' => [ 'base' => 'The properties of this WorkSpace are currently being modified. Try again in a moment.
', 'refs' => [], ], 'OperationNotSupportedException' => [ 'base' => 'This operation is not supported.
', 'refs' => [], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountModificationsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeApplicationAssociationsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeConnectionAliasPermissionsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeConnectionAliasesRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeIpGroupsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspaceBundlesRequest$NextToken' => 'The token for the next set of results. (You received this token from a previous call.)
', 'DescribeWorkspaceBundlesResult$NextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.
', 'DescribeWorkspaceDirectoriesRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspaceImagePermissionsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspaceImagesRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspacesConnectionStatusRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeWorkspacesPoolSessionsRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'ListAccountLinksRequest$NextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'ListAccountLinksResult$NextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'ListAvailableManagementCidrRangesRequest$NextToken' => 'If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', ], ], 'PendingCreateStandbyWorkspacesRequest' => [ 'base' => 'Information about the standby WorkSpace.
', 'refs' => [ 'PendingCreateStandbyWorkspacesRequestList$member' => NULL, ], ], 'PendingCreateStandbyWorkspacesRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateStandbyWorkspacesResult$PendingStandbyRequests' => 'Information about the standby WorkSpace that was created.
', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'ProtocolList$member' => NULL, ], ], 'ProtocolList' => [ 'base' => NULL, 'refs' => [ 'WorkspaceProperties$Protocols' => 'The protocol. For more information, see Protocols for Amazon WorkSpaces.
Only available for WorkSpaces created with PCoIP bundles.
The Protocols
property is case sensitive. Ensure you use PCOIP
or WSP
.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
Describes the information used to reboot a WorkSpace.
', 'refs' => [ 'RebootWorkspaceRequests$member' => NULL, ], ], 'RebootWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'RebootWorkspacesRequest$RebootWorkspaceRequests' => 'The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
', ], ], 'RebootWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RebootWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'RebuildRequest' => [ 'base' => 'Describes the information used to rebuild a WorkSpace.
', 'refs' => [ 'RebuildWorkspaceRequests$member' => NULL, ], ], 'RebuildWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'RebuildWorkspacesRequest$RebuildWorkspaceRequests' => 'The WorkSpace to rebuild. You can specify a single WorkSpace.
', ], ], 'RebuildWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RebuildWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'ReconnectEnum' => [ 'base' => NULL, 'refs' => [ 'ClientProperties$ReconnectEnabled' => 'Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
', 'SelfservicePermissions$RestartWorkspace' => 'Specifies whether users can restart their WorkSpace.
', 'SelfservicePermissions$IncreaseVolumeSize' => 'Specifies whether users can increase the volume size of the drives on their WorkSpace.
', 'SelfservicePermissions$ChangeComputeType' => 'Specifies whether users can change the compute type (bundle) for their WorkSpace.
', 'SelfservicePermissions$SwitchRunningMode' => 'Specifies whether users can switch the running mode of their WorkSpace.
', 'SelfservicePermissions$RebuildWorkspace' => 'Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$SourceRegion' => 'The identifier of the source Region.
', 'CreateStandbyWorkspacesRequest$PrimaryRegion' => 'The Region of the primary WorkSpace.
', 'RelatedWorkspaceProperties$Region' => 'The Region of the related WorkSpace.
', ], ], 'RegisterWorkspaceDirectoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterWorkspaceDirectoryResult' => [ 'base' => NULL, 'refs' => [], ], 'RegistrationCode' => [ 'base' => NULL, 'refs' => [ 'WorkspaceDirectory$RegistrationCode' => 'The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
', ], ], 'RejectAccountLinkInvitationRequest' => [ 'base' => NULL, 'refs' => [], ], 'RejectAccountLinkInvitationResult' => [ 'base' => NULL, 'refs' => [], ], 'RelatedWorkspaceProperties' => [ 'base' => 'Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
', 'refs' => [ 'RelatedWorkspaces$member' => NULL, ], ], 'RelatedWorkspaces' => [ 'base' => NULL, 'refs' => [ 'Workspace$RelatedWorkspaces' => 'The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
', ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'The specified resource already exists.
', 'refs' => [], ], 'ResourceAssociatedException' => [ 'base' => 'The resource is associated with a directory.
', 'refs' => [], ], 'ResourceCreationFailedException' => [ 'base' => 'The resource could not be created.
', 'refs' => [], ], 'ResourceIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeClientPropertiesRequest$ResourceIds' => 'The resource identifier, in the form of directory IDs.
', ], ], 'ResourceInUseException' => [ 'base' => 'The specified resource is currently in use.
', 'refs' => [], ], 'ResourceLimitExceededException' => [ 'base' => 'Your resource limits have been exceeded.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The resource could not be found.
', 'refs' => [], ], 'ResourceUnavailableException' => [ 'base' => 'The specified resource is not available.
', 'refs' => [], ], 'RestoreWorkspaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreWorkspaceResult' => [ 'base' => NULL, 'refs' => [], ], 'RevokeIpRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeIpRulesResult' => [ 'base' => NULL, 'refs' => [], ], 'RootStorage' => [ 'base' => 'Describes the root volume for a WorkSpace bundle.
', 'refs' => [ 'CreateWorkspaceBundleRequest$RootStorage' => NULL, 'WorkspaceBundle$RootStorage' => 'The size of the root volume.
', ], ], 'RootVolumeSizeGib' => [ 'base' => NULL, 'refs' => [ 'WorkspaceProperties$RootVolumeSizeGib' => 'The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
', ], ], 'RunningMode' => [ 'base' => NULL, 'refs' => [ 'WorkspaceProperties$RunningMode' => 'The running mode. For more information, see Manage the WorkSpace Running Mode.
The MANUAL
value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'ApplicationSettingsResponse$S3BucketName' => 'The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.
', ], ], 'SamlProperties' => [ 'base' => 'Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
', 'refs' => [ 'ModifySamlPropertiesRequest$SamlProperties' => 'The properties for configuring SAML 2.0 authentication.
', 'WorkspaceDirectory$SamlProperties' => 'Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
', ], ], 'SamlStatusEnum' => [ 'base' => NULL, 'refs' => [ 'SamlProperties$Status' => 'Indicates the status of SAML 2.0 authentication. These statuses include the following.
If the setting is DISABLED
, end users will be directed to login with their directory credentials.
If the setting is ENABLED
, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
', ], ], 'SecretsManagerArn' => [ 'base' => NULL, 'refs' => [ 'ActiveDirectoryConfig$ServiceAccountSecretArn' => 'Indicates the secret ARN on the service account.
', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'DefaultWorkspaceCreationProperties$CustomSecurityGroupId' => 'The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
', 'WorkspaceCreationProperties$CustomSecurityGroupId' => 'The identifier of your custom security group.
', 'WorkspaceDirectory$WorkspaceSecurityGroupId' => 'The identifier of the security group that is assigned to new WorkSpaces.
', ], ], 'SelfservicePermissions' => [ 'base' => 'Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
', 'refs' => [ 'ModifySelfservicePermissionsRequest$SelfservicePermissions' => 'The permissions to enable or disable self-service capabilities.
', 'WorkspaceDirectory$SelfservicePermissions' => 'The default self-service permissions for WorkSpaces in the directory.
', ], ], 'SessionConnectionState' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolSession$ConnectionState' => 'Specifies whether a user is connected to the pool session.
', ], ], 'SessionInstanceId' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolSession$InstanceId' => 'The identifier for the instance hosting the session.
', ], ], 'SettingsGroup' => [ 'base' => NULL, 'refs' => [ 'ApplicationSettingsRequest$SettingsGroup' => 'The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.
', 'ApplicationSettingsResponse$SettingsGroup' => 'The path prefix for the S3 bucket where users’ persistent application settings are stored.
', ], ], 'Snapshot' => [ 'base' => 'Describes a snapshot.
', 'refs' => [ 'SnapshotList$member' => NULL, ], ], 'SnapshotList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceSnapshotsResult$RebuildSnapshots' => 'Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
', 'DescribeWorkspaceSnapshotsResult$RestoreSnapshots' => 'Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
', ], ], 'StandbyWorkspace' => [ 'base' => 'Describes a standby WorkSpace.
', 'refs' => [ 'FailedCreateStandbyWorkspacesRequest$StandbyWorkspaceRequest' => 'Information about the standby WorkSpace that could not be created.
', 'StandbyWorkspacesList$member' => NULL, ], ], 'StandbyWorkspaceRelationshipType' => [ 'base' => NULL, 'refs' => [ 'RelatedWorkspaceProperties$Type' => 'Indicates the type of WorkSpace.
', ], ], 'StandbyWorkspacesList' => [ 'base' => NULL, 'refs' => [ 'CreateStandbyWorkspacesRequest$StandbyWorkspaces' => 'Information about the standby WorkSpace to be created.
', ], ], 'StandbyWorkspacesProperties' => [ 'base' => 'Describes the properties of the related standby WorkSpaces.
', 'refs' => [ 'StandbyWorkspacesPropertiesList$member' => NULL, ], ], 'StandbyWorkspacesPropertiesList' => [ 'base' => NULL, 'refs' => [ 'Workspace$StandbyWorkspacesProperties' => 'The properties of the standby WorkSpace
', ], ], 'StartRequest' => [ 'base' => 'Information used to start a WorkSpace.
', 'refs' => [ 'StartWorkspaceRequests$member' => NULL, ], ], 'StartWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'StartWorkspacesRequest$StartWorkspaceRequests' => 'The WorkSpaces to start. You can specify up to 25 WorkSpaces.
', ], ], 'StartWorkspacesPoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkspacesPoolResult' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'StopRequest' => [ 'base' => 'Describes the information used to stop a WorkSpace.
', 'refs' => [ 'StopWorkspaceRequests$member' => NULL, ], ], 'StopWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'StopWorkspacesRequest$StopWorkspaceRequests' => 'The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
', ], ], 'StopWorkspacesPoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkspacesPoolResult' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'StorageConnector' => [ 'base' => 'Describes the storage connector.
', 'refs' => [ 'StorageConnectors$member' => NULL, ], ], 'StorageConnectorStatusEnum' => [ 'base' => NULL, 'refs' => [ 'StorageConnector$Status' => 'Indicates if the storage connetor is enabled or disabled.
', ], ], 'StorageConnectorTypeEnum' => [ 'base' => NULL, 'refs' => [ 'StorageConnector$ConnectorType' => 'The type of connector used to save user files.
', ], ], 'StorageConnectors' => [ 'base' => NULL, 'refs' => [ 'StreamingProperties$StorageConnectors' => 'Indicates the storage connector used
', ], ], 'StreamingExperiencePreferredProtocolEnum' => [ 'base' => NULL, 'refs' => [ 'StreamingProperties$StreamingExperiencePreferredProtocol' => 'Indicates the type of preferred protocol for the streaming experience.
', ], ], 'StreamingProperties' => [ 'base' => 'Describes the streaming properties.
', 'refs' => [ 'ModifyStreamingPropertiesRequest$StreamingProperties' => 'The streaming properties to configure.
', 'WorkspaceDirectory$StreamingProperties' => 'The streaming properties to configure.
', ], ], 'String2048' => [ 'base' => NULL, 'refs' => [ 'AssociationStateReason$ErrorMessage' => 'The error message of the association deployment failure.
', 'WorkSpaceApplication$Description' => 'The description of the WorkSpace application.
', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, 'Workspace$SubnetId' => 'The identifier of the subnet for the WorkSpace.
', ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$SubnetIds' => 'The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
', 'WorkspaceDirectory$SubnetIds' => 'The identifiers of the subnets used with the directory.
', ], ], 'Tag' => [ 'base' => 'Describes a tag.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => 'The key of the tag.
', ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'DeleteTagsRequest$TagKeys' => 'The tag keys.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$Tags' => 'The tags for the image.
', 'CreateConnectionAliasRequest$Tags' => 'The tags to associate with the connection alias.
', 'CreateIpGroupRequest$Tags' => 'The tags. Each WorkSpaces resource can have a maximum of 50 tags.
', 'CreateTagsRequest$Tags' => 'The tags. Each WorkSpaces resource can have a maximum of 50 tags.
', 'CreateUpdatedWorkspaceImageRequest$Tags' => 'The tags that you want to add to the new updated WorkSpace image.
To add tags at the same time when you\'re creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags
.
The tags associated with the bundle.
To add tags at the same time when you\'re creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags
.
The tags that you want to add to the new WorkSpace image. To add tags when you\'re creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags
.
The tags for the pool.
', 'DescribeTagsResult$TagList' => 'The tags.
', 'ImportWorkspaceImageRequest$Tags' => 'The tags. Each WorkSpaces resource can have a maximum of 50 tags.
', 'RegisterWorkspaceDirectoryRequest$Tags' => 'The tags associated with the directory.
', 'StandbyWorkspace$Tags' => 'The tags associated with the standby WorkSpace.
', 'WorkspaceRequest$Tags' => 'The tags for the WorkSpace.
', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => 'The value of the tag.
', ], ], 'TargetWorkspaceState' => [ 'base' => NULL, 'refs' => [ 'ModifyWorkspaceStateRequest$WorkspaceState' => 'The WorkSpace state.
', ], ], 'Tenancy' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$Tenancy' => 'Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED
and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED
. For more information, see Bring Your Own Windows Desktop Images.
Describes the information used to terminate a WorkSpace.
', 'refs' => [ 'TerminateWorkspaceRequests$member' => NULL, ], ], 'TerminateWorkspaceRequests' => [ 'base' => NULL, 'refs' => [ 'TerminateWorkspacesRequest$TerminateWorkspaceRequests' => 'The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
', ], ], 'TerminateWorkspacesPoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesPoolResult' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesPoolSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesPoolSessionResult' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'TerminateWorkspacesResult' => [ 'base' => NULL, 'refs' => [], ], 'TimeoutSettings' => [ 'base' => 'Describes the timeout settings for a pool of WorkSpaces.
', 'refs' => [ 'CreateWorkspacesPoolRequest$TimeoutSettings' => 'Indicates the timeout settings of the pool.
', 'UpdateWorkspacesPoolRequest$TimeoutSettings' => 'Indicates the timeout settings of the specified pool.
', 'WorkspacesPool$TimeoutSettings' => 'The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AccountModification$StartTime' => 'The timestamp when the modification of the BYOL configuration was started.
', 'ApplicationResourceAssociation$Created' => 'The time the association was created.
', 'ApplicationResourceAssociation$LastUpdatedTime' => 'The time the association status was last updated.
', 'BundleResourceAssociation$Created' => 'The time the association is created.
', 'BundleResourceAssociation$LastUpdatedTime' => 'The time the association status was last updated.
', 'CreateWorkspaceImageResult$Created' => 'The date when the image was created.
', 'DataReplicationSettings$RecoverySnapshotTime' => 'The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
', 'ImageResourceAssociation$Created' => 'The time the association is created.
', 'ImageResourceAssociation$LastUpdatedTime' => 'The time the association status was last updated.
', 'Snapshot$SnapshotTime' => 'The time when the snapshot was created.
', 'StandbyWorkspacesProperties$RecoverySnapshotTime' => 'The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
', 'WorkSpaceApplication$Created' => 'The time the application is created.
', 'WorkspaceBundle$LastUpdatedTime' => 'The last time that the bundle was updated.
', 'WorkspaceBundle$CreationTime' => 'The time when the bundle was created.
', 'WorkspaceConnectionStatus$ConnectionStateCheckTimestamp' => 'The timestamp of the connection status check.
', 'WorkspaceConnectionStatus$LastKnownUserConnectionTimestamp' => 'The timestamp of the last known user connection.
', 'WorkspaceImage$Created' => 'The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
', 'WorkspaceResourceAssociation$Created' => 'The time the association is created.
', 'WorkspaceResourceAssociation$LastUpdatedTime' => 'The time the association status was last updated.
', 'WorkspacesPool$CreatedAt' => 'The time the pool was created.
', 'WorkspacesPoolSession$ExpirationTime' => 'The time that the pool session ended.
', 'WorkspacesPoolSession$StartTime' => 'The time that the pool sission started.
', ], ], 'UnsupportedNetworkConfigurationException' => [ 'base' => 'The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
', 'refs' => [], ], 'UnsupportedWorkspaceConfigurationException' => [ 'base' => 'The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
', 'refs' => [], ], 'UpdateConnectClientAddInRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectClientAddInResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionAliasPermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionAliasPermissionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDescription' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesPoolRequest$Description' => 'The pool description.
', 'UpdateResult$Description' => 'A description of whether updates for the WorkSpace image are pending or available.
', 'UpdateWorkspacesPoolRequest$Description' => 'Describes the specified pool to update.
', 'WorkspacesPool$Description' => 'The description of the pool.
', ], ], 'UpdateResult' => [ 'base' => 'Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.
Only Windows 10 WorkSpace images can be programmatically updated at this time.
The updates (if any) that are available for the specified image.
', ], ], 'UpdateRulesOfIpGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRulesOfIpGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspaceBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspaceBundleResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspaceImagePermissionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspaceImagePermissionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspacesPoolRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkspacesPoolResult' => [ 'base' => NULL, 'refs' => [], ], 'UserIdentityType' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$UserIdentityType' => 'The type of identity management the user is using.
', 'WorkspaceDirectory$UserIdentityType' => 'Indicates the identity type of the specifired user.
', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesRequest$UserName' => 'The name of the directory user. You must specify this parameter with DirectoryId
.
Describes the standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
', 'Workspace$UserName' => 'The user for the WorkSpace.
', 'WorkspaceDirectory$CustomerUserName' => 'The user name for the service account.
', 'WorkspaceRequest$UserName' => 'The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The reserved keyword, [UNDEFINED]
, is used when creating user-decoupled WorkSpaces.
Information about the user\'s permission settings.
', 'refs' => [ 'UserSettings$member' => NULL, ], ], 'UserSettingActionEnum' => [ 'base' => NULL, 'refs' => [ 'UserSetting$Action' => 'Indicates the type of action.
', ], ], 'UserSettingPermissionEnum' => [ 'base' => NULL, 'refs' => [ 'UserSetting$Permission' => 'Indicates if the setting is enabled or disabled.
', ], ], 'UserSettings' => [ 'base' => NULL, 'refs' => [ 'StreamingProperties$UserSettings' => 'Indicates the permission settings asscoiated with the user.
', ], ], 'UserStorage' => [ 'base' => 'Describes the user volume for a WorkSpace bundle.
', 'refs' => [ 'CreateWorkspaceBundleRequest$UserStorage' => NULL, 'WorkspaceBundle$UserStorage' => 'The size of the user volume.
', ], ], 'UserVolumeSizeGib' => [ 'base' => NULL, 'refs' => [ 'WorkspaceProperties$UserVolumeSizeGib' => 'The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
', ], ], 'ValidationException' => [ 'base' => 'You either haven\'t provided a TargetAccountId
or are using the same value for TargetAccountId
and SourceAccountId
.
The volume encryption key of the standby WorkSpace.
', 'Workspace$VolumeEncryptionKey' => 'The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
', 'WorkspaceRequest$VolumeEncryptionKey' => 'The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
', ], ], 'WorkSpaceApplication' => [ 'base' => 'Describes the WorkSpace application.
', 'refs' => [ 'WorkSpaceApplicationList$member' => NULL, ], ], 'WorkSpaceApplicationDeployment' => [ 'base' => 'Describes the WorkSpace application deployment.
', 'refs' => [ 'DeployWorkspaceApplicationsResult$Deployment' => 'The list of deployed associations and information about them.
', ], ], 'WorkSpaceApplicationId' => [ 'base' => NULL, 'refs' => [ 'ApplicationResourceAssociation$ApplicationId' => 'The identifier of the application.
', 'AssociateWorkspaceApplicationRequest$ApplicationId' => 'The identifier of the application.
', 'DescribeApplicationAssociationsRequest$ApplicationId' => 'The identifier of the specified application.
', 'DisassociateWorkspaceApplicationRequest$ApplicationId' => 'The identifier of the application.
', 'WorkSpaceApplication$ApplicationId' => 'The identifier of the application.
', 'WorkSpaceApplicationIdList$member' => NULL, ], ], 'WorkSpaceApplicationIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$ApplicationIds' => 'The identifiers of one or more applications.
', ], ], 'WorkSpaceApplicationLicenseType' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$LicenseType' => 'The license availability for the applications.
', 'WorkSpaceApplication$LicenseType' => 'The license availability for the applications.
', ], ], 'WorkSpaceApplicationList' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsResult$Applications' => 'List of information about the specified applications.
', ], ], 'WorkSpaceApplicationOwner' => [ 'base' => NULL, 'refs' => [ 'DescribeApplicationsRequest$Owner' => 'The owner of the applications.
', 'WorkSpaceApplication$Owner' => 'The owner of the WorkSpace application.
', ], ], 'WorkSpaceApplicationState' => [ 'base' => NULL, 'refs' => [ 'WorkSpaceApplication$State' => 'The status of WorkSpace application.
', ], ], 'WorkSpaceAssociatedResourceType' => [ 'base' => NULL, 'refs' => [ 'WorkSpaceAssociatedResourceTypeList$member' => NULL, 'WorkspaceResourceAssociation$AssociatedResourceType' => 'The resource types of the associated resource.
', ], ], 'WorkSpaceAssociatedResourceTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceAssociationsRequest$AssociatedResourceTypes' => 'The resource types of the associated resources.
', ], ], 'Workspace' => [ 'base' => 'Describes a WorkSpace.
', 'refs' => [ 'WorkspaceList$member' => NULL, ], ], 'WorkspaceAccessProperties' => [ 'base' => 'The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.
', 'refs' => [ 'ModifyWorkspaceAccessPropertiesRequest$WorkspaceAccessProperties' => 'The device types and operating systems to enable or disable for access.
', 'WorkspaceDirectory$WorkspaceAccessProperties' => 'The devices and operating systems that users can use to access WorkSpaces.
', ], ], 'WorkspaceBundle' => [ 'base' => 'Describes a WorkSpace bundle.
', 'refs' => [ 'BundleList$member' => NULL, 'CreateWorkspaceBundleResult$WorkspaceBundle' => NULL, ], ], 'WorkspaceBundleDescription' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspaceBundleRequest$BundleDescription' => 'The description of the bundle.
', ], ], 'WorkspaceBundleName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspaceBundleRequest$BundleName' => 'The name of the bundle.
', ], ], 'WorkspaceBundleState' => [ 'base' => NULL, 'refs' => [ 'WorkspaceBundle$State' => 'The state of the WorkSpace bundle.
', ], ], 'WorkspaceConnectionStatus' => [ 'base' => 'Describes the connection status of a WorkSpace.
', 'refs' => [ 'WorkspaceConnectionStatusList$member' => NULL, ], ], 'WorkspaceConnectionStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesConnectionStatusResult$WorkspacesConnectionStatus' => 'Information about the connection status of the WorkSpace.
', ], ], 'WorkspaceCreationProperties' => [ 'base' => 'Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
', 'refs' => [ 'ModifyWorkspaceCreationPropertiesRequest$WorkspaceCreationProperties' => 'The default properties for creating WorkSpaces.
', ], ], 'WorkspaceDirectory' => [ 'base' => 'Describes a directory that is used with Amazon WorkSpaces.
', 'refs' => [ 'DirectoryList$member' => NULL, ], ], 'WorkspaceDirectoryDescription' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$WorkspaceDirectoryDescription' => 'Description of the directory to register.
', 'WorkspaceDirectory$WorkspaceDirectoryDescription' => 'The description of the WorkSpace directory
', ], ], 'WorkspaceDirectoryName' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryRequest$WorkspaceDirectoryName' => 'The name of the directory to register.
', 'WorkspaceDirectory$WorkspaceDirectoryName' => 'The name fo the WorkSpace directory.
', 'WorkspaceDirectoryNameList$member' => NULL, ], ], 'WorkspaceDirectoryNameList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceDirectoriesRequest$WorkspaceDirectoryNames' => 'The names of the WorkSpace directories.
', ], ], 'WorkspaceDirectoryState' => [ 'base' => NULL, 'refs' => [ 'RegisterWorkspaceDirectoryResult$State' => 'The registration status of the WorkSpace directory.
', 'WorkspaceDirectory$State' => 'The state of the directory\'s registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED
state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn\'t returned, then the directory has been successfully deregistered.
The directory type.
', ], ], 'WorkspaceErrorCode' => [ 'base' => NULL, 'refs' => [ 'AccountModification$ErrorCode' => 'The error code that is returned if the configuration of BYOL cannot be modified.
', 'FailedCreateStandbyWorkspacesRequest$ErrorCode' => 'The error code that is returned if the standby WorkSpace could not be created.
', 'Workspace$ErrorCode' => 'The error code that is returned if the WorkSpace cannot be created.
', ], ], 'WorkspaceId' => [ 'base' => NULL, 'refs' => [ 'AssociateWorkspaceApplicationRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'CreateWorkspaceImageRequest$WorkspaceId' => 'The identifier of the source WorkSpace
', 'DeployWorkspaceApplicationsRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'DescribeWorkspaceAssociationsRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'DescribeWorkspaceSnapshotsRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'DisassociateWorkspaceApplicationRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'FailedWorkspaceChangeRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'MigrateWorkspaceRequest$SourceWorkspaceId' => 'The identifier of the WorkSpace to migrate from.
', 'MigrateWorkspaceResult$SourceWorkspaceId' => 'The original identifier of the WorkSpace that is being migrated.
', 'MigrateWorkspaceResult$TargetWorkspaceId' => 'The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
', 'ModifyWorkspacePropertiesRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'ModifyWorkspaceStateRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'PendingCreateStandbyWorkspacesRequest$WorkspaceId' => 'The identifier of the standby WorkSpace.
', 'RebootRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'RebuildRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'RelatedWorkspaceProperties$WorkspaceId' => 'The identifier of the related WorkSpace.
', 'RestoreWorkspaceRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'StandbyWorkspace$PrimaryWorkspaceId' => 'The identifier of the standby WorkSpace.
', 'StandbyWorkspacesProperties$StandbyWorkspaceId' => 'The identifier of the standby WorkSpace
', 'StartRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'StopRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'TerminateRequest$WorkspaceId' => 'The identifier of the WorkSpace.
', 'Workspace$WorkspaceId' => 'The identifier of the WorkSpace.
', 'WorkspaceConnectionStatus$WorkspaceId' => 'The identifier of the WorkSpace.
', 'WorkspaceIdList$member' => NULL, 'WorkspaceResourceAssociation$WorkspaceId' => 'The identifier of the WorkSpace.
', ], ], 'WorkspaceIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesConnectionStatusRequest$WorkspaceIds' => 'The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
', 'DescribeWorkspacesRequest$WorkspaceIds' => 'The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
', ], ], 'WorkspaceImage' => [ 'base' => 'Describes a WorkSpace image.
', 'refs' => [ 'WorkspaceImageList$member' => NULL, ], ], 'WorkspaceImageDescription' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$Description' => 'A description of the image.
', 'CreateUpdatedWorkspaceImageRequest$Description' => 'A description of whether updates for the WorkSpace image are available.
', 'CreateWorkspaceImageRequest$Description' => 'The description of the new WorkSpace image.
', 'CreateWorkspaceImageResult$Description' => 'The description of the image.
', 'ImportWorkspaceImageRequest$ImageDescription' => 'The description of the WorkSpace image.
', 'WorkspaceImage$Description' => 'The description of the image.
', ], ], 'WorkspaceImageErrorCode' => [ 'base' => NULL, 'refs' => [ 'WorkspaceImage$ErrorCode' => 'The error code that is returned for the image.
', ], ], 'WorkspaceImageErrorDetailCode' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorCode' => 'Indicates the error code returned.
', ], ], 'WorkspaceImageId' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$SourceImageId' => 'The identifier of the source image.
', 'CopyWorkspaceImageResult$ImageId' => 'The identifier of the image.
', 'CreateUpdatedWorkspaceImageRequest$SourceImageId' => 'The identifier of the source WorkSpace image.
', 'CreateUpdatedWorkspaceImageResult$ImageId' => 'The identifier of the new updated WorkSpace image.
', 'CreateWorkspaceBundleRequest$ImageId' => 'The identifier of the image that is used to create the bundle.
', 'CreateWorkspaceImageResult$ImageId' => 'The identifier of the new WorkSpace image.
', 'DeleteWorkspaceImageRequest$ImageId' => 'The identifier of the image.
', 'DescribeImageAssociationsRequest$ImageId' => 'The identifier of the image.
', 'DescribeWorkspaceImagePermissionsRequest$ImageId' => 'The identifier of the image.
', 'DescribeWorkspaceImagePermissionsResult$ImageId' => 'The identifier of the image.
', 'ImageResourceAssociation$ImageId' => 'The identifier of the image.
', 'ImportWorkspaceImageResult$ImageId' => 'The identifier of the WorkSpace image.
', 'UpdateWorkspaceBundleRequest$ImageId' => 'The identifier of the image.
', 'UpdateWorkspaceImagePermissionRequest$ImageId' => 'The identifier of the image.
', 'WorkspaceBundle$ImageId' => 'The identifier of the image that was used to create the bundle.
', 'WorkspaceImage$ImageId' => 'The identifier of the image.
', 'WorkspaceImageIdList$member' => NULL, ], ], 'WorkspaceImageIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceImagesRequest$ImageIds' => 'The identifier of the image.
', ], ], 'WorkspaceImageIngestionProcess' => [ 'base' => NULL, 'refs' => [ 'ImportWorkspaceImageRequest$IngestionProcess' => 'The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP
. To use PCoIP, specify a value that does not end in _WSP
. To use BYOP, specify a value that ends in _BYOP
.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR
, BYOL_REGULAR_WSP
, or BYOL_REGULAR_BYOP
, depending on the protocol.
The BYOL_REGULAR_BYOP
and BYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
Information about the images.
', ], ], 'WorkspaceImageName' => [ 'base' => NULL, 'refs' => [ 'CopyWorkspaceImageRequest$Name' => 'The name of the image.
', 'CreateUpdatedWorkspaceImageRequest$Name' => 'The name of the new updated WorkSpace image.
', 'CreateWorkspaceImageRequest$Name' => 'The name of the new WorkSpace image.
', 'CreateWorkspaceImageResult$Name' => 'The name of the image.
', 'ImportWorkspaceImageRequest$ImageName' => 'The name of the WorkSpace image.
', 'WorkspaceImage$Name' => 'The name of the image.
', ], ], 'WorkspaceImageRequiredTenancy' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspaceImageResult$RequiredTenancy' => 'Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
', 'WorkspaceImage$RequiredTenancy' => 'Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED
. For more information, see Bring Your Own Windows Desktop Images.
The availability status of the image.
', 'WorkspaceImage$State' => 'The status of the image.
', ], ], 'WorkspaceList' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesResult$PendingRequests' => 'Information about the WorkSpaces that were created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
', 'DescribeWorkspacesResult$Workspaces' => 'Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
', ], ], 'WorkspaceName' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesRequest$WorkspaceName' => 'The name of the user-decoupled WorkSpace.
', 'Workspace$WorkspaceName' => 'The name of the user-decoupled WorkSpace.
', 'WorkspaceRequest$WorkspaceName' => 'The name of the user-decoupled WorkSpace.
', ], ], 'WorkspaceProperties' => [ 'base' => 'Describes a WorkSpace.
', 'refs' => [ 'ModifyWorkspacePropertiesRequest$WorkspaceProperties' => 'The properties of the WorkSpace.
', 'Workspace$WorkspaceProperties' => 'The properties of the WorkSpace.
', 'WorkspaceRequest$WorkspaceProperties' => 'The WorkSpace properties.
', ], ], 'WorkspaceRequest' => [ 'base' => 'Describes the information used to create a WorkSpace.
', 'refs' => [ 'FailedCreateWorkspaceRequest$WorkspaceRequest' => 'Information about the WorkSpace.
', 'WorkspaceRequestList$member' => NULL, ], ], 'WorkspaceRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesRequest$Workspaces' => 'The WorkSpaces to create. You can specify up to 25 WorkSpaces.
', ], ], 'WorkspaceResourceAssociation' => [ 'base' => 'Describes the association between an application and a WorkSpace resource.
', 'refs' => [ 'AssociateWorkspaceApplicationResult$Association' => 'Information about the association between the specified WorkSpace and the specified application.
', 'DisassociateWorkspaceApplicationResult$Association' => 'Information about the targeted association.
', 'WorkspaceResourceAssociationList$member' => NULL, ], ], 'WorkspaceResourceAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspaceAssociationsResult$Associations' => 'List of information about the specified associations.
', 'WorkSpaceApplicationDeployment$Associations' => 'The associations between the applications and the associated resources.
', ], ], 'WorkspaceState' => [ 'base' => NULL, 'refs' => [ 'PendingCreateStandbyWorkspacesRequest$State' => 'The operational state of the standby WorkSpace.
', 'RelatedWorkspaceProperties$State' => 'Indicates the state of the WorkSpace.
', 'Workspace$State' => 'The operational state of the WorkSpace.
PENDING
– The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
AVAILABLE
– The WorkSpace is running and has passed the health checks.
IMPAIRED
– Refer to UNHEALTHY
state.
UNHEALTHY
– The WorkSpace is not responding to health checks.
REBOOTING
– The WorkSpace is being rebooted (restarted).
STARTING
– The WorkSpace is starting up and health checks are being run.
REBUILDING
– The WorkSpace is being rebuilt.
RESTORING
– The WorkSpace is being restored.
MAINTENANCE
– The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
ADMIN_MAINTENANCE
– The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
TERMINATING
– The WorkSpace is being deleted.
TERMINATED
– The WorkSpace has been deleted.
SUSPENDED
– The WorkSpace has been suspended for image creation.
UPDATING
– The WorkSpace is undergoing an update.
STOPPING
– The WorkSpace is being stopped.
STOPPED
– The WorkSpace has been stopped.
ERROR
– The WorkSpace is an error state (for example, an error occurred during startup).
After a WorkSpace is terminated, the TERMINATED
state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn\'t returned, then the WorkSpace has been successfully terminated.
Indicates whether the directory\'s WorkSpace type is personal or pools.
', 'WorkspaceDirectory$WorkspaceType' => 'Indicates whether the directory\'s WorkSpace type is personal or pools.
', ], ], 'WorkspacesDefaultRoleNotFoundException' => [ 'base' => 'The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
', 'refs' => [], ], 'WorkspacesIpGroup' => [ 'base' => 'Describes an IP access control group.
', 'refs' => [ 'WorkspacesIpGroupsList$member' => NULL, ], ], 'WorkspacesIpGroupsList' => [ 'base' => NULL, 'refs' => [ 'DescribeIpGroupsResult$Result' => 'Information about the IP access control groups.
', ], ], 'WorkspacesPool' => [ 'base' => 'Describes a pool of WorkSpaces.
', 'refs' => [ 'CreateWorkspacesPoolResult$WorkspacesPool' => 'Indicates the pool to create.
', 'UpdateWorkspacesPoolResult$WorkspacesPool' => 'Describes the specified pool.
', 'WorkspacesPools$member' => NULL, ], ], 'WorkspacesPoolError' => [ 'base' => 'Describes a pool error.
', 'refs' => [ 'WorkspacesPoolErrors$member' => NULL, ], ], 'WorkspacesPoolErrorCode' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPoolError$ErrorCode' => 'The error code.
', ], ], 'WorkspacesPoolErrors' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPool$Errors' => 'The pool errors.
', ], ], 'WorkspacesPoolId' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolSessionsRequest$PoolId' => 'The identifier of the pool.
', 'StartWorkspacesPoolRequest$PoolId' => 'The identifier of the pool.
', 'StopWorkspacesPoolRequest$PoolId' => 'The identifier of the pool.
', 'TerminateWorkspacesPoolRequest$PoolId' => 'The identifier of the pool.
', 'UpdateWorkspacesPoolRequest$PoolId' => 'The identifier of the specified pool to update.
', 'WorkspacesPool$PoolId' => 'The identifier of a pool.
', 'WorkspacesPoolIds$member' => NULL, 'WorkspacesPoolSession$PoolId' => 'The identifier of the pool.
', ], ], 'WorkspacesPoolIds' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsRequest$PoolIds' => 'The identifier of the WorkSpaces Pools.
', ], ], 'WorkspacesPoolName' => [ 'base' => NULL, 'refs' => [ 'CreateWorkspacesPoolRequest$PoolName' => 'The name of the pool.
', 'WorkspacesPool$PoolName' => 'The name of the pool,
', ], ], 'WorkspacesPoolSession' => [ 'base' => 'Describes a pool session.
', 'refs' => [ 'WorkspacesPoolSessions$member' => NULL, ], ], 'WorkspacesPoolSessions' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolSessionsResult$Sessions' => 'Describes the pool sessions.
', ], ], 'WorkspacesPoolState' => [ 'base' => NULL, 'refs' => [ 'WorkspacesPool$State' => 'The current state of the pool.
', ], ], 'WorkspacesPoolUserId' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolSessionsRequest$UserId' => 'The identifier of the user.
', 'WorkspacesPoolSession$UserId' => 'The identifier of the user.
', ], ], 'WorkspacesPools' => [ 'base' => NULL, 'refs' => [ 'DescribeWorkspacesPoolsResult$WorkspacesPools' => 'Information about the WorkSpaces Pools.
', ], ], ],];